{ "item": [ { "name": "Auth", "item": [ { "name": "Login (WAR)", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "if (pm.response.code === 200) {", " const headerToken = pm.response.headers.get('Authorization');", " const bodyToken = pm.response.text();", " const rawToken = headerToken || bodyToken;", " if (rawToken) {", " const token = rawToken.replace(/^Bearer\\s+/i, '');", " pm.collectionVariables.set('token', token);", " pm.environment.set('token', token);", " }", "}" ] } } ], "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"username\": \"{{username}}\",\n \"password\": \"{{password}}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/auth/signin", "host": [ "{{baseUrl}}" ], "path": [ "api", "auth", "signin" ] }, "description": "Login against the legacy WAR. On 200, stores the bearer token into collection/environment variable `token`." }, "response": [] } ] }, { "name": "api", "description": "", "item": [ { "name": "v2", "description": "", "item": [ { "name": "warehouse-types", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "42dc3fbf-2bef-424e-8a13-dabeda89484e", "name": "Get warehouse type by ID", "request": { "name": "Get warehouse type by ID", "description": { "content": "Returns a single warehouse type by its primary key.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "warehouse-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Warehouse type ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "2735318f-5c99-46f2-bd40-a4a66b7ff61c", "name": "Warehouse type found", "originalRequest": { "url": { "path": [ "api", "v2", "warehouse-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Warehouse type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5d91826b-7a09-47de-8050-3fe1eac90bed", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "warehouse-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Warehouse type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "246cb022-4fc5-4cfc-a0e9-9291236bb517", "name": "Authenticated user is missing the `VER_TIENDATIPOTIENDA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "warehouse-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Warehouse type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "55fc2320-c316-4fab-9171-fba0995c7407", "name": "Warehouse type not found", "originalRequest": { "url": { "path": [ "api", "v2", "warehouse-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Warehouse type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7e972f89-a6f0-4d63-b963-7c666753c7d4", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "warehouse-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Warehouse type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "35ccd3aa-440a-4270-af29-f09d35ebb2ac", "name": "Update warehouse type", "request": { "name": "Update warehouse type", "description": { "content": "Full replacement of an existing warehouse type. Send the `If-Match` header for optimistic concurrency (accepted but ignored ÔÇö not versioned).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "warehouse-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Warehouse type ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "94b7c4b9-f63f-4ca2-9ae8-d84b84cc6f08", "name": "Warehouse type updated", "originalRequest": { "url": { "path": [ "api", "v2", "warehouse-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Warehouse type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a55624d1-3302-49ba-a595-ed15f9ecf793", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "warehouse-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Warehouse type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bced53ac-bf48-4cb7-aa34-379a0754fe46", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "warehouse-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Warehouse type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0a419b71-3375-4b6d-b555-82a61974007d", "name": "Authenticated user is missing the `EDITAR_TIENDATIPOTIENDA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "warehouse-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Warehouse type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6f2256c7-b566-4ae2-bed6-4e6ba35f7da3", "name": "Warehouse type not found", "originalRequest": { "url": { "path": [ "api", "v2", "warehouse-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Warehouse type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f10c0070-94ba-4e95-b20d-5524789e5eee", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "warehouse-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Warehouse type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "dc540a73-319f-436d-aaac-50df930c6af0", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "warehouse-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Warehouse type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cadfec4e-17cb-4af9-84c1-ff600e938587", "name": "Delete warehouse type", "request": { "name": "Delete warehouse type", "description": { "content": "Deletes a warehouse type. Send the `If-Match` header with the current ETag (accepted but ignored ÔÇö not versioned).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "warehouse-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Warehouse type ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "c9a0791f-9d4b-4ec4-9079-5887baced6e6", "name": "Warehouse type deleted", "originalRequest": { "url": { "path": [ "api", "v2", "warehouse-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Warehouse type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "56e0f757-8a3f-4cae-afb8-074dae963f57", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "warehouse-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Warehouse type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "88615ab2-b06c-439a-91ef-db38d6387c26", "name": "Authenticated user is missing the `BORRAR_TIENDATIPOTIENDA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "warehouse-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Warehouse type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0ae02c98-9f9d-43d3-bd52-ec2984fd5a63", "name": "Warehouse type not found", "originalRequest": { "url": { "path": [ "api", "v2", "warehouse-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Warehouse type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "95ca7c4b-8a7a-4b65-a66c-79e8ae670119", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "warehouse-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Warehouse type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "718a6aee-4220-4665-bbbd-4d88b47d0110", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "warehouse-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Warehouse type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e9ad6cf1-e352-42f8-8ed2-cbdded423fa3", "name": "Merge-patch warehouse type", "request": { "name": "Merge-patch warehouse type", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "warehouse-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Warehouse type ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "6308c93c-c4c0-4f19-b80b-6201f3264f90", "name": "Warehouse type patched", "originalRequest": { "url": { "path": [ "api", "v2", "warehouse-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Warehouse type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cdf4949b-49ca-4aef-8f3e-81e713326790", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details. Also returned for malformed merge-patch payloads.", "originalRequest": { "url": { "path": [ "api", "v2", "warehouse-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Warehouse type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "60cb05f7-98cd-4450-b1b5-1030861dfced", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "warehouse-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Warehouse type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "103b3c43-09c1-40a1-b8ea-170135f372e4", "name": "Authenticated user is missing the `EDITAR_TIENDATIPOTIENDA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "warehouse-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Warehouse type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3b1eb1c9-2572-43df-85a9-b9f980b84435", "name": "Warehouse type not found", "originalRequest": { "url": { "path": [ "api", "v2", "warehouse-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Warehouse type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "019c528d-0ddc-4ba7-8ccc-1491624f868b", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "warehouse-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Warehouse type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fd31be40-ef03-4311-83bf-7ada1ea93f28", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "warehouse-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Warehouse type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "d16508d7-713d-4c70-9820-2ed144898900", "name": "List warehouse types", "request": { "name": "List warehouse types", "description": { "content": "Returns a paginated list of warehouse types with envelope `{data, totalCount, skip, limit, hasMore}`. Supports optional RSQL `filter`, `sort` (default `name:asc`), `skip`/`limit` pagination and `modifiedAfter`/`modifiedBefore` bookends.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "warehouse-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "e58c8df4-aca5-4d35-a04a-e445599a60e5", "name": "Page of warehouse types", "originalRequest": { "url": { "path": [ "api", "v2", "warehouse-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "00dbe13b-1f49-4fb1-b820-e4fdf3ff4aea", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "warehouse-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "14ef5628-9fbd-4370-aab9-44afad38ddfa", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "warehouse-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "11fc2887-2150-4587-926e-5f7195360ade", "name": "Authenticated user is missing the `VER_TIENDATIPOTIENDA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "warehouse-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0505e6df-570b-4ef4-bb39-cf0d6c736e14", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "warehouse-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cfca7b7c-5daf-4e33-af22-34653338cb1b", "name": "Create warehouse type", "request": { "name": "Create warehouse type", "description": { "content": "Creates a new warehouse type. Business logic runs in the legacy WAR via the internal commands gateway.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "warehouse-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "43570d77-50f5-4ad0-8cad-42ed17cc7b1e", "name": "Warehouse type created", "originalRequest": { "url": { "path": [ "api", "v2", "warehouse-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "40619fc6-8b2d-4844-999c-5ce80f3882ab", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "warehouse-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4e62b1d4-d04c-4a4b-9fd5-21910bb25e3f", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "warehouse-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ac34db3c-8af9-414f-8178-6ff6024f1d2b", "name": "Authenticated user is missing the `CREAR_TIENDATIPOTIENDA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "warehouse-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9fd9b0a4-e535-4a49-ba8b-5abf34fad55d", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "warehouse-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0d3515f7-ee80-43b3-a5f8-4a5e5c172865", "name": "Bulk delete warehouse types", "request": { "name": "Bulk delete warehouse types", "description": { "content": "Removes every id in `ids` as a single all-or-nothing transaction.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "warehouse-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "d2bbe7b5-80f3-4d48-81d1-e4c9c67e0fd0", "name": "All entities deleted", "originalRequest": { "url": { "path": [ "api", "v2", "warehouse-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"deleted\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c087ba29-16ba-4931-b6b8-5e4a4ffc337e", "name": "Empty `ids` or unknown id", "originalRequest": { "url": { "path": [ "api", "v2", "warehouse-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "91178089-e1bb-409d-aa33-5d9a003f1de5", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "warehouse-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ea293602-05e2-4d8e-9595-bcc007934120", "name": "Authenticated user is missing the `BORRAR_TIENDATIPOTIENDA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "warehouse-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8cc1356e-c9b9-4fbe-9f7a-c58029cfa4fd", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "warehouse-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "new", "description": "", "item": [ { "id": "a2edb9b1-b902-4130-bdbb-ba09d770c92d", "name": "Prototype warehouse type for a creation form", "request": { "name": "Prototype warehouse type for a creation form", "description": { "content": "Returns a non-persisted warehouse type pre-populated with backend defaults (`enabled=true`, current company, next sequential `code`, empty `name`). Optional JSON hints: `companyId`, `copyFromId`. Call `POST /api/v2/warehouse-types` afterwards to persist.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "warehouse-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "73e382e5-9da9-4b6d-bf0f-3a1340583371", "name": "Warehouse type prototype with defaults", "originalRequest": { "url": { "path": [ "api", "v2", "warehouse-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1f87df9f-8e12-4375-ad97-5a0f307cebe7", "name": "Invalid prepare-create hints", "originalRequest": { "url": { "path": [ "api", "v2", "warehouse-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "76927fb2-3365-4794-ba24-243a0dbef19f", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "warehouse-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7c613f7b-fed2-47a1-ba05-71c6fc2701f7", "name": "Authenticated user is missing the `CREAR_TIENDATIPOTIENDA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "warehouse-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f791e97e-bcc0-436e-9cac-4c05e65e149f", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "warehouse-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "visual-therapy-templates", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "b030b510-52d9-4ea6-83ff-afa6ab784bc3", "name": "Get visual therapy template by ID", "request": { "name": "Get visual therapy template by ID", "description": { "content": "Returns a single visual therapy exercise template by its primary key.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "visual-therapy-templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Visual therapy template ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "3e44c850-ce5e-49c1-ada0-f8d5eac3c259", "name": "Visual therapy template found", "originalRequest": { "url": { "path": [ "api", "v2", "visual-therapy-templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Visual therapy template ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"content\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "35626b15-32cc-4367-bff9-afb57db0385a", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "visual-therapy-templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Visual therapy template ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b14384cf-115a-400b-a218-ae40032e53d5", "name": "Authenticated user is missing the `VER_PLANTILLA_EJER_TERAPIA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "visual-therapy-templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Visual therapy template ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c79b1cae-bb4f-4af3-86cc-940ae18a6c23", "name": "Visual therapy template not found", "originalRequest": { "url": { "path": [ "api", "v2", "visual-therapy-templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Visual therapy template ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ee291913-075e-4be1-9f62-552914260393", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "visual-therapy-templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Visual therapy template ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7740c452-29a7-4a7e-b2ab-3656377735a2", "name": "Update visual therapy template", "request": { "name": "Update visual therapy template", "description": { "content": "Full replacement of an existing visual therapy exercise template. Send the `If-Match` header for optimistic concurrency (accepted but ignored ÔÇö not versioned).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "visual-therapy-templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Visual therapy template ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"content\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "2338b732-c9f1-4309-acb5-de53bbcfec0b", "name": "Visual therapy template updated", "originalRequest": { "url": { "path": [ "api", "v2", "visual-therapy-templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Visual therapy template ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"content\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"content\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "58e8ab06-c1ae-4e27-b574-097987f097b5", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "visual-therapy-templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Visual therapy template ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"content\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "836096c9-0ad9-4095-8550-69bb288f7f75", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "visual-therapy-templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Visual therapy template ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"content\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7fde8e88-c9ae-465b-b67c-e1108a210d15", "name": "Authenticated user is missing the `EDITAR_PLANTILLA_EJER_TERAPIA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "visual-therapy-templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Visual therapy template ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"content\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6bf70ac9-3ffd-4376-a71a-1732900a456c", "name": "Visual therapy template not found", "originalRequest": { "url": { "path": [ "api", "v2", "visual-therapy-templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Visual therapy template ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"content\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b621f6f5-6f1f-4da9-99c8-72f313deecf7", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "visual-therapy-templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Visual therapy template ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"content\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "57930d0a-b94f-443f-b9d9-2abc530b71c3", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "visual-therapy-templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Visual therapy template ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"content\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "edbfbedd-cbf3-45c6-8628-c1746bc90925", "name": "Delete visual therapy template", "request": { "name": "Delete visual therapy template", "description": { "content": "Deletes a visual therapy exercise template. Send the `If-Match` header with the current ETag (accepted but ignored ÔÇö not versioned).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "visual-therapy-templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Visual therapy template ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "8d7544f3-ad80-4e4f-aabf-823bd21e9bd5", "name": "Visual therapy template deleted", "originalRequest": { "url": { "path": [ "api", "v2", "visual-therapy-templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Visual therapy template ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f5bc49b3-51aa-42a0-b848-12bea79d43e5", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "visual-therapy-templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Visual therapy template ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5e7e9f4b-5d6c-481c-85b6-7462bd1c3e5a", "name": "Authenticated user is missing the `BORRAR_PLANTILLA_EJER_TERAPIA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "visual-therapy-templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Visual therapy template ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f331df3a-82b1-4a76-8084-f6f4e8a816f0", "name": "Visual therapy template not found", "originalRequest": { "url": { "path": [ "api", "v2", "visual-therapy-templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Visual therapy template ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e1a1b490-51f1-45ea-a397-52b2b895b124", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "visual-therapy-templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Visual therapy template ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cccb95a2-f249-419a-a770-bdde1f5dc4ad", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "visual-therapy-templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Visual therapy template ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ce8122a2-3be1-4e66-b640-f9a07785973e", "name": "Merge-patch visual therapy template", "request": { "name": "Merge-patch visual therapy template", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "visual-therapy-templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Visual therapy template ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "b65337ed-a8aa-40ac-b3b5-5ea3b34b3bb8", "name": "Visual therapy template patched", "originalRequest": { "url": { "path": [ "api", "v2", "visual-therapy-templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Visual therapy template ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"content\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ee6afa69-c2e2-420c-bd23-8cb15833c6a8", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details. Also returned for malformed merge-patch payloads.", "originalRequest": { "url": { "path": [ "api", "v2", "visual-therapy-templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Visual therapy template ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "985d60e7-bcf5-46e6-bc24-d5f232ddf131", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "visual-therapy-templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Visual therapy template ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "38e0f28a-ba21-48b2-8983-c52655de623d", "name": "Authenticated user is missing the `EDITAR_PLANTILLA_EJER_TERAPIA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "visual-therapy-templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Visual therapy template ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "150ad5a3-4cda-4fdf-b62d-5a49bcd38b57", "name": "Visual therapy template not found", "originalRequest": { "url": { "path": [ "api", "v2", "visual-therapy-templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Visual therapy template ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a5228790-509c-477e-95da-dc4279f27c0a", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "visual-therapy-templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Visual therapy template ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9707e04b-3012-4e73-998d-835b6bbea174", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "visual-therapy-templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Visual therapy template ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "b342bcdd-c018-4d67-8913-032b86e91363", "name": "List visual therapy templates", "request": { "name": "List visual therapy templates", "description": { "content": "Returns a paginated list of visual therapy exercise templates with envelope `{data, totalCount, skip, limit, hasMore}`. Supports optional RSQL `filter`, `sort` (default `name:asc`), `skip`/`limit` pagination and `modifiedAfter`/`modifiedBefore` bookends.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "visual-therapy-templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "06f8407c-535d-406a-a72f-75cb31bae90b", "name": "Page of visual therapy templates", "originalRequest": { "url": { "path": [ "api", "v2", "visual-therapy-templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9965f4f0-9876-40cc-a888-68b643b0e6c0", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "visual-therapy-templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "101620a9-eb68-43ab-8faf-08744293af6b", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "visual-therapy-templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "123fe3bf-db9f-434a-8543-3c64ace44d14", "name": "Authenticated user is missing the `VER_PLANTILLA_EJER_TERAPIA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "visual-therapy-templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a07c275d-461f-4066-8e8d-2aab11ab740a", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "visual-therapy-templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e8d17c24-b3ee-4baa-8f68-7daec34332b5", "name": "Create visual therapy template", "request": { "name": "Create visual therapy template", "description": { "content": "Creates a new visual therapy exercise template. Business logic runs in the legacy WAR via the internal commands gateway.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "visual-therapy-templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"content\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "185f3bf8-4d0d-4be2-a9be-4c65efd722d1", "name": "Visual therapy template created", "originalRequest": { "url": { "path": [ "api", "v2", "visual-therapy-templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"content\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"content\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "73c9c7ea-4056-42f7-81c9-c2be3f0ef929", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "visual-therapy-templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"content\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9c0b49f3-f84e-4760-9269-1e17f512b28e", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "visual-therapy-templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"content\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c374b249-3c87-4b17-9e43-c27bb07c3786", "name": "Authenticated user is missing the `CREAR_PLANTILLA_EJER_TERAPIA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "visual-therapy-templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"content\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "eb8d8787-c3d9-49bf-b4e6-9d9746992a43", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "visual-therapy-templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"content\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "new", "description": "", "item": [ { "id": "ae660347-0b71-41ea-b7ed-4b3a1567e13b", "name": "Prototype visual therapy template for a creation form", "request": { "name": "Prototype visual therapy template for a creation form", "description": { "content": "Returns a non-persisted visual therapy exercise template pre-populated with backend defaults (`enabled=true`, current company and branch when available). Optional JSON hints: `companyId`, `warehouseId`, `copyFromId`. The response has no `id`, `version` or audit fields; call `POST /api/v2/visual-therapy-templates` afterwards to persist.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "visual-therapy-templates", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "d08aac5c-6e88-4482-be70-911df95ed2ff", "name": "Visual therapy template prototype with defaults", "originalRequest": { "url": { "path": [ "api", "v2", "visual-therapy-templates", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"content\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "59ec1a18-7f0f-4a32-9e88-f425542287a1", "name": "Invalid prepare-create hints", "originalRequest": { "url": { "path": [ "api", "v2", "visual-therapy-templates", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f01ddec7-728b-4f1f-b37d-77a48cbadec9", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "visual-therapy-templates", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "18224003-1068-492a-9a6d-40cbe0ef9d0c", "name": "Authenticated user is missing the `CREAR_PLANTILLA_EJER_TERAPIA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "visual-therapy-templates", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a9cba50a-b602-404b-8464-09f5f0e49508", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "visual-therapy-templates", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "visit-reasons", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "d0da8402-6339-4d7c-b880-43fb7ce46465", "name": "Get visit reason by ID", "request": { "name": "Get visit reason by ID", "description": { "content": "Returns a single visit reason by its primary key.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "visit-reasons", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Visit reason ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "9f4afe61-ec6a-48f1-ac6b-f9effac1eca4", "name": "Visit reason found", "originalRequest": { "url": { "path": [ "api", "v2", "visit-reasons", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Visit reason ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ec2c2f95-b6cb-4033-a427-0659af8c4f82", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "visit-reasons", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Visit reason ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c7ebd573-1d3e-4f77-8320-68d1bfa7c28e", "name": "Authenticated user is missing the `VER_MOTIVOSDEVISITA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "visit-reasons", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Visit reason ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3b8d1cae-bf74-43b7-a664-af8976101416", "name": "Visit reason not found", "originalRequest": { "url": { "path": [ "api", "v2", "visit-reasons", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Visit reason ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2ffad026-dddb-4b84-94c8-265fdaac5dfe", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "visit-reasons", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Visit reason ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "14e9e28a-6b11-4ed9-8fc1-b8e99173f100", "name": "Update visit reason", "request": { "name": "Update visit reason", "description": { "content": "Full replacement of an existing visit reason.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "visit-reasons", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Visit reason ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "0a3280e9-ea05-4066-930c-faa4814782c9", "name": "Visit reason updated", "originalRequest": { "url": { "path": [ "api", "v2", "visit-reasons", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Visit reason ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8b5d3e31-7e95-41e3-a77e-4f3fbc3f68aa", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "visit-reasons", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Visit reason ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e16ab4e1-4641-42fe-b55d-6a286ece0dcf", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "visit-reasons", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Visit reason ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2ac3ae2e-3c1e-40cf-b2d7-c17762511517", "name": "Authenticated user is missing the `EDITAR_MOTIVOSDEVISITA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "visit-reasons", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Visit reason ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "787b34f0-1995-4eb0-a371-212c450efafa", "name": "Visit reason not found", "originalRequest": { "url": { "path": [ "api", "v2", "visit-reasons", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Visit reason ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c472fc13-9245-49e0-ab99-70ad8dd2075d", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "visit-reasons", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Visit reason ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6a724472-27c6-4dca-86d7-4cee7005f97b", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "visit-reasons", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Visit reason ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a0d5d794-0749-4377-bdc2-b20beb616a84", "name": "Delete visit reason", "request": { "name": "Delete visit reason", "description": { "content": "Deletes a visit reason.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "visit-reasons", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Visit reason ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "ddbe0742-1e2d-4ac8-a86b-0a312eeb4644", "name": "Visit reason deleted", "originalRequest": { "url": { "path": [ "api", "v2", "visit-reasons", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Visit reason ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1a538017-05a5-4a7b-941e-baf53e93f562", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "visit-reasons", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Visit reason ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "89f87b90-42cf-43a1-8728-01ebe5e54f9e", "name": "Authenticated user is missing the `BORRAR_MOTIVOSDEVISITA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "visit-reasons", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Visit reason ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ebab1c4a-333e-40c2-a799-5abb26770150", "name": "Visit reason not found", "originalRequest": { "url": { "path": [ "api", "v2", "visit-reasons", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Visit reason ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7d20b7aa-ead5-4b91-ba5e-badaf3875236", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "visit-reasons", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Visit reason ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "eea30d32-43a5-4d4f-a6d1-ab1bf9aa39e3", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "visit-reasons", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Visit reason ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e72e166c-ae5c-4312-bdc4-4a32657836ef", "name": "Merge-patch visit reason", "request": { "name": "Merge-patch visit reason", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "visit-reasons", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Visit reason ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "dd104196-02c5-4d86-b4ca-0e750bd866bf", "name": "Visit reason patched", "originalRequest": { "url": { "path": [ "api", "v2", "visit-reasons", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Visit reason ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ac51443c-b449-4770-bd47-a78a77308e79", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "visit-reasons", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Visit reason ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9ce94927-f4df-4638-a11a-15106d685e6f", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "visit-reasons", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Visit reason ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "792c1aa6-1303-4822-a27b-79daf7393445", "name": "Authenticated user is missing the `EDITAR_MOTIVOSDEVISITA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "visit-reasons", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Visit reason ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "df2aa1c4-cfca-47a7-ae84-0e0678c5155c", "name": "Visit reason not found", "originalRequest": { "url": { "path": [ "api", "v2", "visit-reasons", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Visit reason ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9a108bed-b8d9-43ae-bde9-8b1a2b5b749e", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "visit-reasons", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Visit reason ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "05422c22-9c1a-410f-9aea-ffde987a41d4", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "visit-reasons", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Visit reason ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "2c0bf0f9-324f-4477-ae03-2b6e3759b1ce", "name": "List visit reasons", "request": { "name": "List visit reasons", "description": { "content": "Returns a paginated list of visit reasons with envelope `{data, totalCount, skip, limit, hasMore}`. Supports optional RSQL `filter`, `sort` (default `lastModifiedAt:desc`), `skip`/`limit` pagination and `modifiedAfter`/`modifiedBefore` bookends.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "visit-reasons" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "7db596ba-c08f-4efb-ab48-51a55321c9b7", "name": "Page of visit reasons", "originalRequest": { "url": { "path": [ "api", "v2", "visit-reasons" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4d33095c-b6d0-43a4-8ce7-e2eec50f6a05", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "visit-reasons" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d4f453a1-8071-435a-9942-e16ea92ac848", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "visit-reasons" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "58d4f1c9-71ea-4ea1-b100-8715745f91dd", "name": "Authenticated user is missing the `VER_MOTIVOSDEVISITA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "visit-reasons" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "79005c55-f4f6-4bf4-b2ec-ef08f6ffe8eb", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "visit-reasons" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d4f9fd48-6818-4e74-ab26-1f1e7109a08f", "name": "Create visit reason", "request": { "name": "Create visit reason", "description": { "content": "Creates a new visit reason. Business logic runs in the legacy WAR. `code` is optional: when omitted the WAR assigns the next sequential company-scoped code (same rule as `POST /visit-reasons/new`).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "visit-reasons" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "bfba369e-996d-450c-b556-d162e881da17", "name": "Visit reason created", "originalRequest": { "url": { "path": [ "api", "v2", "visit-reasons" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "19433ec1-ed66-4c59-a5af-75f8f8b25a50", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "visit-reasons" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ca955137-1a27-4122-af37-787c76a9c746", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "visit-reasons" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "afc1d7bb-533e-4479-a66e-481cc2bc6d31", "name": "Authenticated user is missing the `CREAR_MOTIVOSDEVISITA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "visit-reasons" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9fb03f49-4dcc-4266-9b36-fb6236216171", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "visit-reasons" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5225897b-7aed-4f20-9ab5-cef768db0ac1", "name": "Bulk delete visit reasons", "request": { "name": "Bulk delete visit reasons", "description": { "content": "Removes every id in `ids` as a single all-or-nothing transaction.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "visit-reasons" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "0b59f266-4f86-44f8-bff6-a29384fc30ab", "name": "All entities deleted", "originalRequest": { "url": { "path": [ "api", "v2", "visit-reasons" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"deleted\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2c02c26a-273e-4a7e-b560-1807d658a01b", "name": "Empty `ids` or unknown id", "originalRequest": { "url": { "path": [ "api", "v2", "visit-reasons" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7173a0d8-b22d-481c-96b5-bfe3f0651685", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "visit-reasons" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9e72e5d5-3443-4207-a802-b850d132708b", "name": "Authenticated user is missing the `BORRAR_MOTIVOSDEVISITA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "visit-reasons" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1c1cb43f-b5aa-4076-a19e-2a11109e77e9", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "visit-reasons" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "22bb635f-e0a9-4f5c-8270-c2742aedd2e4", "name": "Bulk patch visit reasons", "request": { "name": "Bulk patch visit reasons", "description": { "content": "Applies the same `patch` to every id in `ids` as a single all-or-nothing transaction. Editable fields: `enabled`, `description`.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "visit-reasons" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"patch\": {\n \"key_0\": \"string\",\n \"key_1\": 4074,\n \"key_2\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "731b55dc-4d59-4b9d-8127-18c0c76e02aa", "name": "All entities updated", "originalRequest": { "url": { "path": [ "api", "v2", "visit-reasons" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"patch\": {\n \"key_0\": \"string\",\n \"key_1\": 4074,\n \"key_2\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"updated\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e3d78bce-06d3-4d14-b2bf-ddd51ce4aa5a", "name": "Empty `ids`/`patch`, malformed payload or non-whitelisted field", "originalRequest": { "url": { "path": [ "api", "v2", "visit-reasons" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"patch\": {\n \"key_0\": \"string\",\n \"key_1\": 4074,\n \"key_2\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c1c3da76-56ae-4dff-a82d-2dbee5831ec6", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "visit-reasons" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"patch\": {\n \"key_0\": \"string\",\n \"key_1\": 4074,\n \"key_2\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6346ac88-2062-4709-a079-f95fc3fe81fe", "name": "Authenticated user is missing the `EDITAR_MOTIVOSDEVISITA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "visit-reasons" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"patch\": {\n \"key_0\": \"string\",\n \"key_1\": 4074,\n \"key_2\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "26a8127a-8baf-4dbe-9442-3657256a69b0", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "visit-reasons" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"patch\": {\n \"key_0\": \"string\",\n \"key_1\": 4074,\n \"key_2\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "new", "description": "", "item": [ { "id": "3803eafd-1d02-476a-8849-fa3d80d868aa", "name": "Prototype visit reason for a creation form", "request": { "name": "Prototype visit reason for a creation form", "description": { "content": "Returns a non-persisted visit reason pre-populated with backend defaults (current company, next sequential `code`, `enabled=true`). Optional JSON hints: `companyId`, `copyFromId`. Call `POST /api/v2/visit-reasons` to persist.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "visit-reasons", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "5f621879-21d2-4f83-9b19-2f74094b9ba1", "name": "Visit reason prototype with defaults", "originalRequest": { "url": { "path": [ "api", "v2", "visit-reasons", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d6c6edf8-5c29-4421-bfdb-d6ebe00728a8", "name": "Invalid prepare-create hints", "originalRequest": { "url": { "path": [ "api", "v2", "visit-reasons", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "454525e3-c009-4104-8955-42cc99dc584d", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "visit-reasons", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5ed30609-78ab-49ef-bd98-8654cdca99ec", "name": "Authenticated user is missing the `CREAR_MOTIVOSDEVISITA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "visit-reasons", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bfbf8fb0-9a31-4822-97ec-6b73697576df", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "visit-reasons", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "views", "description": "", "item": [ { "name": "{viewId}", "description": "", "item": [ { "id": "50cb870b-c94a-4577-bb70-7cd50e744ce1", "name": "Get the metadata of a grid view", "request": { "name": "Get the metadata of a grid view", "description": { "content": "Returns columns, default sort, capabilities, actions and the user's persisted UI state. The view is built from the FieldDef catalog when the legacy plantilla is not configured (`{feature}-main` always works), and overridden by the user's plantilla when one exists. Cached for 5 minutes per the contract.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "views", ":viewId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "viewId", "disabled": false, "description": { "content": "(Required) Registered view identifier", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "1f4f478c-67c9-4da8-9974-20f9eba84abf", "name": "View definition", "originalRequest": { "url": { "path": [ "api", "v2", "views", ":viewId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Registered view identifier", "type": "text/plain" }, "type": "any", "value": "", "key": "viewId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"viewId\": \"\",\n \"featureType\": \"\",\n \"rowIdField\": \"\",\n \"defaultSort\": [\n {\n \"colId\": \"\",\n \"sort\": \"asc\"\n },\n {\n \"colId\": \"\",\n \"sort\": \"asc\"\n }\n ],\n \"columns\": [\n {\n \"field\": \"\",\n \"headerName\": \"\",\n \"type\": \"dateTime\",\n \"hide\": \"\",\n \"sortable\": \"\",\n \"editable\": \"\",\n \"bulkEditable\": \"\",\n \"width\": \"\",\n \"filter\": \"agSetColumnFilter\",\n \"filterParams\": {\n \"values\": [\n \"\",\n \"\"\n ],\n \"catalog\": \"\",\n \"catalogParams\": {\n \"companyRequired\": \"\",\n \"key\": \"\",\n \"parameters\": [\n {\n \"name\": \"\",\n \"required\": \"\",\n \"type\": \"STRING\"\n },\n {\n \"name\": \"\",\n \"required\": \"\",\n \"type\": \"BOOLEAN\"\n }\n ],\n \"source\": \"STATIC\"\n },\n \"suppressSorting\": \"\",\n \"defaultToNothingSelected\": \"\",\n \"buttons\": \"clear\"\n },\n \"enableRowGroup\": \"\",\n \"aggFunc\": \"sum\",\n \"cellRenderer\": \"\",\n \"cellRendererParams\": {\n \"key_0\": 9494.157904723825\n },\n \"featureType\": \"\",\n \"navigable\": \"\"\n },\n {\n \"field\": \"\",\n \"headerName\": \"\",\n \"type\": \"percentage\",\n \"hide\": \"\",\n \"sortable\": \"\",\n \"editable\": \"\",\n \"bulkEditable\": \"\",\n \"width\": \"\",\n \"filter\": \"agDateColumnFilter\",\n \"filterParams\": {\n \"values\": [\n \"\",\n \"\"\n ],\n \"catalog\": \"\",\n \"catalogParams\": {\n \"companyRequired\": \"\",\n \"key\": \"\",\n \"parameters\": [\n {\n \"name\": \"\",\n \"required\": \"\",\n \"type\": \"STRING\"\n },\n {\n \"name\": \"\",\n \"required\": \"\",\n \"type\": \"BOOLEAN\"\n }\n ],\n \"source\": \"DYNAMIC\"\n },\n \"suppressSorting\": \"\",\n \"defaultToNothingSelected\": \"\",\n \"buttons\": \"reset\"\n },\n \"enableRowGroup\": \"\",\n \"aggFunc\": \"sum\",\n \"cellRenderer\": \"\",\n \"cellRendererParams\": {\n \"key_0\": 691\n },\n \"featureType\": \"\",\n \"navigable\": \"\"\n }\n ],\n \"actions\": [\n {\n \"id\": \"\",\n \"label\": \"\",\n \"icon\": \"\",\n \"scope\": \"\",\n \"origin\": \"\",\n \"permission\": \"\",\n \"selectionMode\": \"single\",\n \"destructive\": \"\",\n \"disabled\": \"\",\n \"showWhen\": \"always\",\n \"aiDescription\": \"\",\n \"execution\": {\n \"type\": \"dialog\",\n \"method\": \"POST\",\n \"url\": \"\",\n \"body\": {\n \"key_0\": \"string\"\n }\n }\n },\n {\n \"id\": \"\",\n \"label\": \"\",\n \"icon\": \"\",\n \"scope\": \"\",\n \"origin\": \"\",\n \"permission\": \"\",\n \"selectionMode\": \"multi\",\n \"destructive\": \"\",\n \"disabled\": \"\",\n \"showWhen\": \"edit\",\n \"aiDescription\": \"\",\n \"execution\": {\n \"type\": \"dialog\",\n \"method\": \"POST\",\n \"url\": \"\",\n \"body\": {\n \"key_0\": 1291\n }\n }\n }\n ],\n \"userState\": {\n \"columnWidths\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"hiddenColumns\": [\n \"\",\n \"\"\n ],\n \"pinnedColumns\": {\n \"left\": [\n \"\",\n \"\"\n ],\n \"right\": [\n \"\",\n \"\"\n ]\n },\n \"filterModel\": {\n \"key_0\": false,\n \"key_1\": 7988.2806821268005\n },\n \"filterMode\": \"column\",\n \"sortModel\": [\n {\n \"colId\": \"\",\n \"sort\": \"desc\"\n },\n {\n \"colId\": \"\",\n \"sort\": \"asc\"\n }\n ],\n \"columnOrder\": [\n \"\",\n \"\"\n ],\n \"savedAt\": \"\"\n },\n \"capabilities\": {\n \"canFilter\": \"\",\n \"canSort\": \"\",\n \"canGroup\": \"\",\n \"canPivot\": \"\",\n \"canExport\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "eb2e63ac-d43a-4734-a1af-d1c3958b027e", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "views", ":viewId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Registered view identifier", "type": "text/plain" }, "type": "any", "value": "", "key": "viewId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9a4fca32-e3c0-4e13-9a35-a4030f8f6c91", "name": "Authenticated user is missing the entity's read permission", "originalRequest": { "url": { "path": [ "api", "v2", "views", ":viewId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Registered view identifier", "type": "text/plain" }, "type": "any", "value": "", "key": "viewId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e304249f-69a2-413e-b3e6-45f991824928", "name": "View not registered", "originalRequest": { "url": { "path": [ "api", "v2", "views", ":viewId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Registered view identifier", "type": "text/plain" }, "type": "any", "value": "", "key": "viewId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "174c44bf-5986-4b84-9d8e-c5b550ad88a5", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "views", ":viewId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Registered view identifier", "type": "text/plain" }, "type": "any", "value": "", "key": "viewId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "296ea15d-34ba-492f-94b4-6274053bda96", "name": "Save the column layout of a view", "request": { "name": "Save the column layout of a view", "description": { "content": "Persists the column selection (order + width). The list is the visible column set; the backend keeps adding the PK, FK pair counterparts and ALWAYS_VISIBLE_COLUMN fields on the next GET. Both native (`name`, `code`...) and custom (`customFields.`) apiNames are accepted.\n\nWith a **numeric viewId** the columns of THAT template are updated (the \"Save\" button of the template bar); the caller needs `canEdit` on it ÔÇö owner or EDITAR_PLANTILLASGLOBALES ÔÇö and a private template of another user answers 404. Unknown apiNames are rejected with 400 on named templates.\n\n**DEPRECATED (slug form)**: `PUT` on `{featureType}-main` still performs the historical implicit upsert of the user's un-named plantilla, but it is deprecated in favour of named templates (`POST /api/v2/views` + `PUT /api/v2/views/{plantillaId}`). It will start answering 400 once the SPA migrates to the template bar.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "views", ":viewId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "viewId", "disabled": false, "description": { "content": "(Required) Registered view identifier: slug or numeric template id", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"columns\": [\n {\n \"field\": \"\",\n \"width\": \"\"\n },\n {\n \"field\": \"\",\n \"width\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "30882b31-b443-4d2d-8abd-06f71431abaa", "name": "Layout saved", "originalRequest": { "url": { "path": [ "api", "v2", "views", ":viewId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Registered view identifier: slug or numeric template id", "type": "text/plain" }, "type": "any", "value": "", "key": "viewId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"columns\": [\n {\n \"field\": \"\",\n \"width\": \"\"\n },\n {\n \"field\": \"\",\n \"width\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a41fbe82-aa26-456f-87f0-81660f876991", "name": "Invalid payload, unknown apiNames on a named template, or feature without a writable plantilla", "originalRequest": { "url": { "path": [ "api", "v2", "views", ":viewId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Registered view identifier: slug or numeric template id", "type": "text/plain" }, "type": "any", "value": "", "key": "viewId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"columns\": [\n {\n \"field\": \"\",\n \"width\": \"\"\n },\n {\n \"field\": \"\",\n \"width\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "76bf98db-ff3f-44c1-8d2c-451d090744c5", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "views", ":viewId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Registered view identifier: slug or numeric template id", "type": "text/plain" }, "type": "any", "value": "", "key": "viewId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"columns\": [\n {\n \"field\": \"\",\n \"width\": \"\"\n },\n {\n \"field\": \"\",\n \"width\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8356a7da-0b79-4468-a59f-f6d6ff52d8ce", "name": "Missing edit permission on the entity, or no edit rights over the referenced template", "originalRequest": { "url": { "path": [ "api", "v2", "views", ":viewId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Registered view identifier: slug or numeric template id", "type": "text/plain" }, "type": "any", "value": "", "key": "viewId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"columns\": [\n {\n \"field\": \"\",\n \"width\": \"\"\n },\n {\n \"field\": \"\",\n \"width\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3fe4fa12-1bde-4887-8a08-010630bdcba6", "name": "View not registered (or private template of another user)", "originalRequest": { "url": { "path": [ "api", "v2", "views", ":viewId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Registered view identifier: slug or numeric template id", "type": "text/plain" }, "type": "any", "value": "", "key": "viewId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"columns\": [\n {\n \"field\": \"\",\n \"width\": \"\"\n },\n {\n \"field\": \"\",\n \"width\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "873b8288-ad88-462c-84eb-eb3478a3bbc0", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "views", ":viewId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Registered view identifier: slug or numeric template id", "type": "text/plain" }, "type": "any", "value": "", "key": "viewId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"columns\": [\n {\n \"field\": \"\",\n \"width\": \"\"\n },\n {\n \"field\": \"\",\n \"width\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9c324f06-0b4a-49ba-8198-f21948740642", "name": "Delete a view template", "request": { "name": "Delete a view template", "description": { "content": "Deletes a named template and sweeps every reference: the template selection of ALL users (`UserPreferencesDocument.viewTemplates` stops listing it, so they fall back to the system view) and the per-user grid states persisted for this viewId. Idempotent: deleting an id that no longer exists returns 204. The system view is not deletable (400).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "views", ":viewId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "viewId", "disabled": false, "description": { "content": "(Required) Numeric id of a persisted template", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "3d5e1f5f-008b-4cb1-b2bd-7f930f254a28", "name": "Template deleted (or it no longer existed)", "originalRequest": { "url": { "path": [ "api", "v2", "views", ":viewId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Numeric id of a persisted template", "type": "text/plain" }, "type": "any", "value": "", "key": "viewId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d5d2be44-a19b-4dd2-bb3c-8f6e7f1098be", "name": "viewId is the system view or not a named template", "originalRequest": { "url": { "path": [ "api", "v2", "views", ":viewId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Numeric id of a persisted template", "type": "text/plain" }, "type": "any", "value": "", "key": "viewId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "54b97545-d596-4a84-99cc-ea657a851b86", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "views", ":viewId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Numeric id of a persisted template", "type": "text/plain" }, "type": "any", "value": "", "key": "viewId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "52eecebc-5633-4d18-a19c-5d5d64120314", "name": "Caller has no delete rights over this template", "originalRequest": { "url": { "path": [ "api", "v2", "views", ":viewId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Numeric id of a persisted template", "type": "text/plain" }, "type": "any", "value": "", "key": "viewId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b70841d8-38b6-43eb-bb4a-ab32d28b611c", "name": "Private template of another user", "originalRequest": { "url": { "path": [ "api", "v2", "views", ":viewId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Numeric id of a persisted template", "type": "text/plain" }, "type": "any", "value": "", "key": "viewId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8cca4942-f593-4714-b76f-d21f735acd6a", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "views", ":viewId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Numeric id of a persisted template", "type": "text/plain" }, "type": "any", "value": "", "key": "viewId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "91094a10-e07e-45ba-8789-d2b555b3ff11", "name": "Rename or change visibility of a view template", "request": { "name": "Rename or change visibility of a view template", "description": { "content": "Merge-patch of `{ name?, visibility? }`; omitted fields are left untouched. Columns are NOT patched here ÔÇö they go through the existing `PUT /api/v2/views/{viewId}`. The system view (`{featureType}-main`) is not patchable (400). A private template of another user answers 404 (not 403).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "views", ":viewId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "viewId", "disabled": false, "description": { "content": "(Required) Numeric id of a persisted template", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"visibility\": \"everyone\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "f17aafb7-a27c-449e-8c89-6936949bb19c", "name": "Updated template summary", "originalRequest": { "url": { "path": [ "api", "v2", "views", ":viewId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Numeric id of a persisted template", "type": "text/plain" }, "type": "any", "value": "", "key": "viewId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"visibility\": \"everyone\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"viewId\": \"\",\n \"plantillaId\": \"\",\n \"featureType\": \"\",\n \"name\": \"\",\n \"system\": \"\",\n \"visibility\": \"private\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"canEdit\": \"\",\n \"canDelete\": \"\",\n \"updatedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "315f56ff-25a5-47cf-a01d-1c56411b574e", "name": "viewId is the system view / not a named template, or invalid body", "originalRequest": { "url": { "path": [ "api", "v2", "views", ":viewId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Numeric id of a persisted template", "type": "text/plain" }, "type": "any", "value": "", "key": "viewId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"visibility\": \"everyone\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7a5f0fb6-b079-4ec0-877a-6db31b3f0c5b", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "views", ":viewId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Numeric id of a persisted template", "type": "text/plain" }, "type": "any", "value": "", "key": "viewId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"visibility\": \"everyone\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "52461542-1e9d-4254-8790-82f4d9b1bf2d", "name": "Caller has no edit rights over this template", "originalRequest": { "url": { "path": [ "api", "v2", "views", ":viewId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Numeric id of a persisted template", "type": "text/plain" }, "type": "any", "value": "", "key": "viewId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"visibility\": \"everyone\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "70326f5d-55f4-48a8-b029-ad5a5dcf42d3", "name": "Template does not exist (or is a private template of another user)", "originalRequest": { "url": { "path": [ "api", "v2", "views", ":viewId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Numeric id of a persisted template", "type": "text/plain" }, "type": "any", "value": "", "key": "viewId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"visibility\": \"everyone\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d0dce3d9-94d6-4705-b569-2fd0bb6017e0", "name": "A template with the same name already exists for this feature and owner", "originalRequest": { "url": { "path": [ "api", "v2", "views", ":viewId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Numeric id of a persisted template", "type": "text/plain" }, "type": "any", "value": "", "key": "viewId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"visibility\": \"everyone\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5715dba7-93df-4126-87ed-9078bc4394d8", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "views", ":viewId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Numeric id of a persisted template", "type": "text/plain" }, "type": "any", "value": "", "key": "viewId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"visibility\": \"everyone\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "user-state", "description": "", "item": [ { "id": "85a26bac-8dcc-4438-b4f5-f3d5304fc97d", "name": "Persist the user's UI state for a view", "request": { "name": "Persist the user's UI state for a view", "description": { "content": "Body is the full `UserGridState`. The backend stores it verbatim associated to (userId, viewId) and overwrites the existing state. `filterModel` is OPAQUE: never interpreted by the backend. Max payload ~32 KB.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "views", ":viewId", "user-state" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "viewId", "disabled": false, "description": { "content": "(Required) Registered view identifier", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"columnWidths\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"hiddenColumns\": [\n \"\",\n \"\"\n ],\n \"pinnedColumns\": {\n \"left\": [\n \"\",\n \"\"\n ],\n \"right\": [\n \"\",\n \"\"\n ]\n },\n \"filterModel\": {\n \"key_0\": 2240,\n \"key_1\": 6785,\n \"key_2\": 6292.942509662967\n },\n \"filterMode\": \"column\",\n \"sortModel\": [\n {\n \"colId\": \"\",\n \"sort\": \"asc\"\n },\n {\n \"colId\": \"\",\n \"sort\": \"desc\"\n }\n ],\n \"columnOrder\": [\n \"\",\n \"\"\n ],\n \"savedAt\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "d1ae23a4-8000-44dd-adfc-70d28fcf2401", "name": "User state saved", "originalRequest": { "url": { "path": [ "api", "v2", "views", ":viewId", "user-state" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Registered view identifier", "type": "text/plain" }, "type": "any", "value": "", "key": "viewId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"columnWidths\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"hiddenColumns\": [\n \"\",\n \"\"\n ],\n \"pinnedColumns\": {\n \"left\": [\n \"\",\n \"\"\n ],\n \"right\": [\n \"\",\n \"\"\n ]\n },\n \"filterModel\": {\n \"key_0\": 2240,\n \"key_1\": 6785,\n \"key_2\": 6292.942509662967\n },\n \"filterMode\": \"column\",\n \"sortModel\": [\n {\n \"colId\": \"\",\n \"sort\": \"asc\"\n },\n {\n \"colId\": \"\",\n \"sort\": \"desc\"\n }\n ],\n \"columnOrder\": [\n \"\",\n \"\"\n ],\n \"savedAt\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "34e6a1e6-5e52-4b31-970d-16910937d127", "name": "Invalid JSON or payload too large", "originalRequest": { "url": { "path": [ "api", "v2", "views", ":viewId", "user-state" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Registered view identifier", "type": "text/plain" }, "type": "any", "value": "", "key": "viewId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"columnWidths\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"hiddenColumns\": [\n \"\",\n \"\"\n ],\n \"pinnedColumns\": {\n \"left\": [\n \"\",\n \"\"\n ],\n \"right\": [\n \"\",\n \"\"\n ]\n },\n \"filterModel\": {\n \"key_0\": 2240,\n \"key_1\": 6785,\n \"key_2\": 6292.942509662967\n },\n \"filterMode\": \"column\",\n \"sortModel\": [\n {\n \"colId\": \"\",\n \"sort\": \"asc\"\n },\n {\n \"colId\": \"\",\n \"sort\": \"desc\"\n }\n ],\n \"columnOrder\": [\n \"\",\n \"\"\n ],\n \"savedAt\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "55ae4436-4704-4b05-ba28-92ce562560d8", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "views", ":viewId", "user-state" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Registered view identifier", "type": "text/plain" }, "type": "any", "value": "", "key": "viewId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"columnWidths\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"hiddenColumns\": [\n \"\",\n \"\"\n ],\n \"pinnedColumns\": {\n \"left\": [\n \"\",\n \"\"\n ],\n \"right\": [\n \"\",\n \"\"\n ]\n },\n \"filterModel\": {\n \"key_0\": 2240,\n \"key_1\": 6785,\n \"key_2\": 6292.942509662967\n },\n \"filterMode\": \"column\",\n \"sortModel\": [\n {\n \"colId\": \"\",\n \"sort\": \"asc\"\n },\n {\n \"colId\": \"\",\n \"sort\": \"desc\"\n }\n ],\n \"columnOrder\": [\n \"\",\n \"\"\n ],\n \"savedAt\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2f3cfa9f-a45b-4b85-bfbd-e6f088179414", "name": "View not registered", "originalRequest": { "url": { "path": [ "api", "v2", "views", ":viewId", "user-state" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Registered view identifier", "type": "text/plain" }, "type": "any", "value": "", "key": "viewId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"columnWidths\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"hiddenColumns\": [\n \"\",\n \"\"\n ],\n \"pinnedColumns\": {\n \"left\": [\n \"\",\n \"\"\n ],\n \"right\": [\n \"\",\n \"\"\n ]\n },\n \"filterModel\": {\n \"key_0\": 2240,\n \"key_1\": 6785,\n \"key_2\": 6292.942509662967\n },\n \"filterMode\": \"column\",\n \"sortModel\": [\n {\n \"colId\": \"\",\n \"sort\": \"asc\"\n },\n {\n \"colId\": \"\",\n \"sort\": \"desc\"\n }\n ],\n \"columnOrder\": [\n \"\",\n \"\"\n ],\n \"savedAt\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ec34b956-b4e2-43bd-af41-c0f09b43c3a2", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "views", ":viewId", "user-state" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Registered view identifier", "type": "text/plain" }, "type": "any", "value": "", "key": "viewId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"columnWidths\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"hiddenColumns\": [\n \"\",\n \"\"\n ],\n \"pinnedColumns\": {\n \"left\": [\n \"\",\n \"\"\n ],\n \"right\": [\n \"\",\n \"\"\n ]\n },\n \"filterModel\": {\n \"key_0\": 2240,\n \"key_1\": 6785,\n \"key_2\": 6292.942509662967\n },\n \"filterMode\": \"column\",\n \"sortModel\": [\n {\n \"colId\": \"\",\n \"sort\": \"asc\"\n },\n {\n \"colId\": \"\",\n \"sort\": \"desc\"\n }\n ],\n \"columnOrder\": [\n \"\",\n \"\"\n ],\n \"savedAt\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d65e0dcf-ef61-42c2-8c51-2ee12e9f390f", "name": "Reset the user's UI state for a view", "request": { "name": "Reset the user's UI state for a view", "description": { "content": "Idempotent. Returns 204 whether or not the user had a persisted state. After this the next GET returns the default layout.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "views", ":viewId", "user-state" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "viewId", "disabled": false, "description": { "content": "(Required) Registered view identifier", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "de27d732-6016-445b-8f33-3229423128bc", "name": "User state cleared", "originalRequest": { "url": { "path": [ "api", "v2", "views", ":viewId", "user-state" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Registered view identifier", "type": "text/plain" }, "type": "any", "value": "", "key": "viewId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5a85fff1-1192-4e48-95c4-d840b838588a", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "views", ":viewId", "user-state" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Registered view identifier", "type": "text/plain" }, "type": "any", "value": "", "key": "viewId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c74b2b1b-d49c-42a9-ba66-033896e4038e", "name": "View not registered", "originalRequest": { "url": { "path": [ "api", "v2", "views", ":viewId", "user-state" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Registered view identifier", "type": "text/plain" }, "type": "any", "value": "", "key": "viewId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "dd130d35-d84f-4fe0-b478-79085cf8bd51", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "views", ":viewId", "user-state" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Registered view identifier", "type": "text/plain" }, "type": "any", "value": "", "key": "viewId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "data", "description": "", "item": [ { "id": "30d9ed29-cb43-4875-8b2c-ccad11b95a30", "name": "Fetch rows for a grid view", "request": { "name": "Fetch rows for a grid view", "description": { "content": "Returns a page of rows that satisfies the QueryDSL (pagination, sort, filter, search, grouping, drill-down). Order of evaluation: search → filter → sort → pagination. The hard limit is 500 rows per page.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "views", ":viewId", "data" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "viewId", "disabled": false, "description": { "content": "(Required) Registered view identifier", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"pagination\": {\n \"offset\": \"\",\n \"limit\": \"\"\n },\n \"sort\": [\n {\n \"field\": \"\",\n \"direction\": \"desc\"\n },\n {\n \"field\": \"\",\n \"direction\": \"asc\"\n }\n ],\n \"filter\": {\n \"logic\": \"\",\n \"conditions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"field\": \"\",\n \"operator\": \"notContains\",\n \"value\": \"\",\n \"valueTo\": \"\",\n \"leaf\": \"\",\n \"group\": \"\"\n },\n \"search\": \"\",\n \"grouping\": [\n {\n \"field\": \"\",\n \"aggFunctions\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n },\n {\n \"field\": \"\",\n \"aggFunctions\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n }\n ],\n \"groupKeys\": [\n \"\",\n \"\"\n ],\n \"pivotColumns\": [\n \"\",\n \"\"\n ],\n \"pivotMode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "280482e6-ceb5-47ad-8ee6-55f387bc2933", "name": "Page of rows for the requested view", "originalRequest": { "url": { "path": [ "api", "v2", "views", ":viewId", "data" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Registered view identifier", "type": "text/plain" }, "type": "any", "value": "", "key": "viewId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"pagination\": {\n \"offset\": \"\",\n \"limit\": \"\"\n },\n \"sort\": [\n {\n \"field\": \"\",\n \"direction\": \"desc\"\n },\n {\n \"field\": \"\",\n \"direction\": \"asc\"\n }\n ],\n \"filter\": {\n \"logic\": \"\",\n \"conditions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"field\": \"\",\n \"operator\": \"notContains\",\n \"value\": \"\",\n \"valueTo\": \"\",\n \"leaf\": \"\",\n \"group\": \"\"\n },\n \"search\": \"\",\n \"grouping\": [\n {\n \"field\": \"\",\n \"aggFunctions\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n },\n {\n \"field\": \"\",\n \"aggFunctions\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n }\n ],\n \"groupKeys\": [\n \"\",\n \"\"\n ],\n \"pivotColumns\": [\n \"\",\n \"\"\n ],\n \"pivotMode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"rows\": [\n {\n \"key_0\": 2432\n },\n {\n \"key_0\": false\n }\n ],\n \"rowCount\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "434536b0-39ed-4ce6-b809-416d7879fc4d", "name": "Invalid QueryDSL (unknown field, incompatible operator, limit > 500, ...)", "originalRequest": { "url": { "path": [ "api", "v2", "views", ":viewId", "data" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Registered view identifier", "type": "text/plain" }, "type": "any", "value": "", "key": "viewId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"pagination\": {\n \"offset\": \"\",\n \"limit\": \"\"\n },\n \"sort\": [\n {\n \"field\": \"\",\n \"direction\": \"desc\"\n },\n {\n \"field\": \"\",\n \"direction\": \"asc\"\n }\n ],\n \"filter\": {\n \"logic\": \"\",\n \"conditions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"field\": \"\",\n \"operator\": \"notContains\",\n \"value\": \"\",\n \"valueTo\": \"\",\n \"leaf\": \"\",\n \"group\": \"\"\n },\n \"search\": \"\",\n \"grouping\": [\n {\n \"field\": \"\",\n \"aggFunctions\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n },\n {\n \"field\": \"\",\n \"aggFunctions\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n }\n ],\n \"groupKeys\": [\n \"\",\n \"\"\n ],\n \"pivotColumns\": [\n \"\",\n \"\"\n ],\n \"pivotMode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e8825374-cfcb-4575-b672-ae389a354970", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "views", ":viewId", "data" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Registered view identifier", "type": "text/plain" }, "type": "any", "value": "", "key": "viewId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"pagination\": {\n \"offset\": \"\",\n \"limit\": \"\"\n },\n \"sort\": [\n {\n \"field\": \"\",\n \"direction\": \"desc\"\n },\n {\n \"field\": \"\",\n \"direction\": \"asc\"\n }\n ],\n \"filter\": {\n \"logic\": \"\",\n \"conditions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"field\": \"\",\n \"operator\": \"notContains\",\n \"value\": \"\",\n \"valueTo\": \"\",\n \"leaf\": \"\",\n \"group\": \"\"\n },\n \"search\": \"\",\n \"grouping\": [\n {\n \"field\": \"\",\n \"aggFunctions\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n },\n {\n \"field\": \"\",\n \"aggFunctions\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n }\n ],\n \"groupKeys\": [\n \"\",\n \"\"\n ],\n \"pivotColumns\": [\n \"\",\n \"\"\n ],\n \"pivotMode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d551e1f6-ef05-4112-89ad-3392ce528901", "name": "Authenticated user is missing the entity's read permission", "originalRequest": { "url": { "path": [ "api", "v2", "views", ":viewId", "data" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Registered view identifier", "type": "text/plain" }, "type": "any", "value": "", "key": "viewId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"pagination\": {\n \"offset\": \"\",\n \"limit\": \"\"\n },\n \"sort\": [\n {\n \"field\": \"\",\n \"direction\": \"desc\"\n },\n {\n \"field\": \"\",\n \"direction\": \"asc\"\n }\n ],\n \"filter\": {\n \"logic\": \"\",\n \"conditions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"field\": \"\",\n \"operator\": \"notContains\",\n \"value\": \"\",\n \"valueTo\": \"\",\n \"leaf\": \"\",\n \"group\": \"\"\n },\n \"search\": \"\",\n \"grouping\": [\n {\n \"field\": \"\",\n \"aggFunctions\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n },\n {\n \"field\": \"\",\n \"aggFunctions\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n }\n ],\n \"groupKeys\": [\n \"\",\n \"\"\n ],\n \"pivotColumns\": [\n \"\",\n \"\"\n ],\n \"pivotMode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "970d0bbf-df30-4e83-b3dd-4e5e7d51dbda", "name": "View not registered", "originalRequest": { "url": { "path": [ "api", "v2", "views", ":viewId", "data" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Registered view identifier", "type": "text/plain" }, "type": "any", "value": "", "key": "viewId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"pagination\": {\n \"offset\": \"\",\n \"limit\": \"\"\n },\n \"sort\": [\n {\n \"field\": \"\",\n \"direction\": \"desc\"\n },\n {\n \"field\": \"\",\n \"direction\": \"asc\"\n }\n ],\n \"filter\": {\n \"logic\": \"\",\n \"conditions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"field\": \"\",\n \"operator\": \"notContains\",\n \"value\": \"\",\n \"valueTo\": \"\",\n \"leaf\": \"\",\n \"group\": \"\"\n },\n \"search\": \"\",\n \"grouping\": [\n {\n \"field\": \"\",\n \"aggFunctions\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n },\n {\n \"field\": \"\",\n \"aggFunctions\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n }\n ],\n \"groupKeys\": [\n \"\",\n \"\"\n ],\n \"pivotColumns\": [\n \"\",\n \"\"\n ],\n \"pivotMode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "680139b4-e80d-425f-b904-a5cba8eac1ca", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "views", ":viewId", "data" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Registered view identifier", "type": "text/plain" }, "type": "any", "value": "", "key": "viewId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"pagination\": {\n \"offset\": \"\",\n \"limit\": \"\"\n },\n \"sort\": [\n {\n \"field\": \"\",\n \"direction\": \"desc\"\n },\n {\n \"field\": \"\",\n \"direction\": \"asc\"\n }\n ],\n \"filter\": {\n \"logic\": \"\",\n \"conditions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"field\": \"\",\n \"operator\": \"notContains\",\n \"value\": \"\",\n \"valueTo\": \"\",\n \"leaf\": \"\",\n \"group\": \"\"\n },\n \"search\": \"\",\n \"grouping\": [\n {\n \"field\": \"\",\n \"aggFunctions\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n },\n {\n \"field\": \"\",\n \"aggFunctions\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n }\n ],\n \"groupKeys\": [\n \"\",\n \"\"\n ],\n \"pivotColumns\": [\n \"\",\n \"\"\n ],\n \"pivotMode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "available-fields", "description": "", "item": [ { "id": "cc8cba4f-b491-4599-9921-48c27b3931f6", "name": "Available fields for a view", "request": { "name": "Available fields for a view", "description": { "content": "Returns every field eligible to be added to the view's plantilla: native FieldDefs (excluding INTERNAL ones) plus the tenant's custom fields. Each entry carries `inPlantilla` so the SPA can render which fields are already part of the user's current layout.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "views", ":viewId", "available-fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "viewId", "disabled": false, "description": { "content": "(Required) Registered view identifier", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "5d3e7ac2-fda8-480a-a9e3-31f0543c9225", "name": "Available field descriptors", "originalRequest": { "url": { "path": [ "api", "v2", "views", ":viewId", "available-fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Registered view identifier", "type": "text/plain" }, "type": "any", "value": "", "key": "viewId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "[\n {\n \"apiName\": \"\",\n \"label\": \"\",\n \"group\": \"\",\n \"type\": \"\",\n \"category\": \"\",\n \"inPlantilla\": \"\",\n \"bulkEditable\": \"\",\n \"alwaysVisible\": \"\",\n \"customFieldId\": \"\"\n },\n {\n \"apiName\": \"\",\n \"label\": \"\",\n \"group\": \"\",\n \"type\": \"\",\n \"category\": \"\",\n \"inPlantilla\": \"\",\n \"bulkEditable\": \"\",\n \"alwaysVisible\": \"\",\n \"customFieldId\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5432cd9a-2185-4258-8f9a-3d4ef86e5c8c", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "views", ":viewId", "available-fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Registered view identifier", "type": "text/plain" }, "type": "any", "value": "", "key": "viewId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "dcfe3c9a-bc46-442c-9ce6-8877a37f3bf2", "name": "Authenticated user is missing the entity's read permission", "originalRequest": { "url": { "path": [ "api", "v2", "views", ":viewId", "available-fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Registered view identifier", "type": "text/plain" }, "type": "any", "value": "", "key": "viewId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "03613e4a-8957-45de-9847-71029e36f3bc", "name": "View not registered", "originalRequest": { "url": { "path": [ "api", "v2", "views", ":viewId", "available-fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Registered view identifier", "type": "text/plain" }, "type": "any", "value": "", "key": "viewId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "19189b00-6fb5-4245-8b38-da9ec99877c9", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "views", ":viewId", "available-fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Registered view identifier", "type": "text/plain" }, "type": "any", "value": "", "key": "viewId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "id": "d1ce5040-3d30-429b-b522-90a6afbbc1c5", "name": "List view templates for a feature", "request": { "name": "List view templates for a feature", "description": { "content": "Returns every template the caller can use for the given featureType: the system view (`{featureType}-main`, always first, not editable), then the tenant-shared templates (`visibility=everyone`) and the caller's private ones, each bucket sorted alphabetically. `canEdit`/`canDelete` are computed for the caller: owner of the template, or holder of the EDITAR_PLANTILLASGLOBALES permission.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "views" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Registered featureType of the listing", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "f4a73a56-5dea-4f3f-9e7b-135ac06a26b0", "name": "Templates visible to the caller", "originalRequest": { "url": { "path": [ "api", "v2", "views" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Registered featureType of the listing", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "[\n {\n \"viewId\": \"\",\n \"plantillaId\": \"\",\n \"featureType\": \"\",\n \"name\": \"\",\n \"system\": \"\",\n \"visibility\": \"private\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"canEdit\": \"\",\n \"canDelete\": \"\",\n \"updatedAt\": \"\"\n },\n {\n \"viewId\": \"\",\n \"plantillaId\": \"\",\n \"featureType\": \"\",\n \"name\": \"\",\n \"system\": \"\",\n \"visibility\": \"private\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"canEdit\": \"\",\n \"canDelete\": \"\",\n \"updatedAt\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b9869c5e-5e32-4967-848a-2392bc3a6c0e", "name": "Missing or unknown featureType", "originalRequest": { "url": { "path": [ "api", "v2", "views" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Registered featureType of the listing", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4d9514e4-bed7-4048-8cbf-32815e7ebcdb", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "views" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Registered featureType of the listing", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b1e01633-ce3d-4109-9abf-14fa10b5cade", "name": "Authenticated user is missing the entity's read permission", "originalRequest": { "url": { "path": [ "api", "v2", "views" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Registered featureType of the listing", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0f5ceffe-d7f9-4773-b185-6619bed02681", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "views" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Registered featureType of the listing", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f4029a0c-9516-45f4-94be-0b2ebf463d1a", "name": "Create a named view template", "request": { "name": "Create a named view template", "description": { "content": "Creates a template from the grid's current column state. `columns` follows the same shape and normalization as saveViewLayout (order + width; PK, FK pairs and ALWAYS_VISIBLE_COLUMN fields are added by the backend on the next GET). The name is unique (case-insensitive) per (tenant, featureType, owner). Creating with `visibility=everyone` requires the EDITAR_PLANTILLASGLOBALES permission. The create does NOT change the caller's selected template; that stays in `PUT /api/v2/me/preferences` (viewTemplates).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "views" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"columns\": [\n {\n \"field\": \"\",\n \"width\": \"\"\n },\n {\n \"field\": \"\",\n \"width\": \"\"\n }\n ],\n \"featureType\": \"\",\n \"name\": \"\",\n \"visibility\": \"private\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "3f81a19c-bcfd-40f6-b97d-067464acaac8", "name": "Template created", "originalRequest": { "url": { "path": [ "api", "v2", "views" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"columns\": [\n {\n \"field\": \"\",\n \"width\": \"\"\n },\n {\n \"field\": \"\",\n \"width\": \"\"\n }\n ],\n \"featureType\": \"\",\n \"name\": \"\",\n \"visibility\": \"private\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"viewId\": \"\",\n \"plantillaId\": \"\",\n \"featureType\": \"\",\n \"name\": \"\",\n \"system\": \"\",\n \"visibility\": \"private\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"canEdit\": \"\",\n \"canDelete\": \"\",\n \"updatedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2df737db-3144-4189-911c-ae9a0d32d3fb", "name": "Invalid name, unknown featureType, empty columns or unknown apiNames", "originalRequest": { "url": { "path": [ "api", "v2", "views" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"columns\": [\n {\n \"field\": \"\",\n \"width\": \"\"\n },\n {\n \"field\": \"\",\n \"width\": \"\"\n }\n ],\n \"featureType\": \"\",\n \"name\": \"\",\n \"visibility\": \"private\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "febd631c-5996-4b47-a027-f985cc5cebf3", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "views" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"columns\": [\n {\n \"field\": \"\",\n \"width\": \"\"\n },\n {\n \"field\": \"\",\n \"width\": \"\"\n }\n ],\n \"featureType\": \"\",\n \"name\": \"\",\n \"visibility\": \"private\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "63d51b6f-d042-4d97-a0b5-c8eb7ff1f132", "name": "Missing read permission, or visibility=everyone without EDITAR_PLANTILLASGLOBALES", "originalRequest": { "url": { "path": [ "api", "v2", "views" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"columns\": [\n {\n \"field\": \"\",\n \"width\": \"\"\n },\n {\n \"field\": \"\",\n \"width\": \"\"\n }\n ],\n \"featureType\": \"\",\n \"name\": \"\",\n \"visibility\": \"private\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "73d20a37-5fab-4a2c-82ff-1f066aa3fe15", "name": "A template with the same name already exists for this feature and owner", "originalRequest": { "url": { "path": [ "api", "v2", "views" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"columns\": [\n {\n \"field\": \"\",\n \"width\": \"\"\n },\n {\n \"field\": \"\",\n \"width\": \"\"\n }\n ],\n \"featureType\": \"\",\n \"name\": \"\",\n \"visibility\": \"private\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ed438c57-d384-4397-82c0-0e42a435fca0", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "views" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"columns\": [\n {\n \"field\": \"\",\n \"width\": \"\"\n },\n {\n \"field\": \"\",\n \"width\": \"\"\n }\n ],\n \"featureType\": \"\",\n \"name\": \"\",\n \"visibility\": \"private\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "users-main", "description": "", "item": [ { "name": "data", "description": "", "item": [ { "id": "2c197f81-5c81-4aa7-bee2-4c3fb1315d77", "name": "users-main SSRM data", "request": { "name": "users-main SSRM data", "description": {}, "url": { "path": [ "api", "v2", "views", "users-main", "data" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"pagination\": {\n \"offset\": \"\",\n \"limit\": \"\"\n },\n \"sort\": [\n {\n \"field\": \"\",\n \"direction\": \"desc\"\n },\n {\n \"field\": \"\",\n \"direction\": \"asc\"\n }\n ],\n \"filter\": {\n \"logic\": \"\",\n \"conditions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"field\": \"\",\n \"operator\": \"notContains\",\n \"value\": \"\",\n \"valueTo\": \"\",\n \"leaf\": \"\",\n \"group\": \"\"\n },\n \"search\": \"\",\n \"grouping\": [\n {\n \"field\": \"\",\n \"aggFunctions\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n },\n {\n \"field\": \"\",\n \"aggFunctions\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n }\n ],\n \"groupKeys\": [\n \"\",\n \"\"\n ],\n \"pivotColumns\": [\n \"\",\n \"\"\n ],\n \"pivotMode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "6e313d55-76e5-45bd-a8e3-039ab0ec85f7", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "views", "users-main", "data" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"pagination\": {\n \"offset\": \"\",\n \"limit\": \"\"\n },\n \"sort\": [\n {\n \"field\": \"\",\n \"direction\": \"desc\"\n },\n {\n \"field\": \"\",\n \"direction\": \"asc\"\n }\n ],\n \"filter\": {\n \"logic\": \"\",\n \"conditions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"field\": \"\",\n \"operator\": \"notContains\",\n \"value\": \"\",\n \"valueTo\": \"\",\n \"leaf\": \"\",\n \"group\": \"\"\n },\n \"search\": \"\",\n \"grouping\": [\n {\n \"field\": \"\",\n \"aggFunctions\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n },\n {\n \"field\": \"\",\n \"aggFunctions\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n }\n ],\n \"groupKeys\": [\n \"\",\n \"\"\n ],\n \"pivotColumns\": [\n \"\",\n \"\"\n ],\n \"pivotMode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "55476985-de1f-41fe-b91d-ccca23173e5f", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "views", "users-main", "data" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"pagination\": {\n \"offset\": \"\",\n \"limit\": \"\"\n },\n \"sort\": [\n {\n \"field\": \"\",\n \"direction\": \"desc\"\n },\n {\n \"field\": \"\",\n \"direction\": \"asc\"\n }\n ],\n \"filter\": {\n \"logic\": \"\",\n \"conditions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"field\": \"\",\n \"operator\": \"notContains\",\n \"value\": \"\",\n \"valueTo\": \"\",\n \"leaf\": \"\",\n \"group\": \"\"\n },\n \"search\": \"\",\n \"grouping\": [\n {\n \"field\": \"\",\n \"aggFunctions\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n },\n {\n \"field\": \"\",\n \"aggFunctions\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n }\n ],\n \"groupKeys\": [\n \"\",\n \"\"\n ],\n \"pivotColumns\": [\n \"\",\n \"\"\n ],\n \"pivotMode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "59655971-d25d-4eec-8982-e87f34c155a2", "name": "users-main view definition", "request": { "name": "users-main view definition", "description": {}, "url": { "path": [ "api", "v2", "views", "users-main" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "35132be8-6c37-4d5d-a6f1-7318f2fcf21a", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "views", "users-main" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4812299a-b2e1-4c88-b894-190cde2182e8", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "views", "users-main" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "vat-types", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "7eadea77-cbe0-46bf-9448-bad8eef17fcb", "name": "Get VAT type by ID", "request": { "name": "Get VAT type by ID", "description": { "content": "Returns the VAT type including warehouseOverrides and associatedAccounts.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "vat-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) VAT type ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "ed164cf4-2299-4c69-a254-a3d28bea56c9", "name": "VAT type found", "originalRequest": { "url": { "path": [ "api", "v2", "vat-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) VAT type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"label\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"vatRate\": \"\",\n \"vatRatePurchase\": \"\",\n \"differentPurchaseSaleVat\": \"\",\n \"vatCategory\": \"\",\n \"nature303\": \"\",\n \"warehouseOverrides\": [\n {\n \"id\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"vatRate\": \"\",\n \"vatRatePurchase\": \"\",\n \"differentPurchaseSaleVat\": \"\",\n \"useVatPriceAsNetPrice\": \"\"\n },\n {\n \"id\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"vatRate\": \"\",\n \"vatRatePurchase\": \"\",\n \"differentPurchaseSaleVat\": \"\",\n \"useVatPriceAsNetPrice\": \"\"\n }\n ],\n \"associatedAccounts\": [\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n },\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n }\n ],\n \"exemptionType\": \"\",\n \"blockType\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"excludeFromLedger\": \"\",\n \"commonVat\": \"\",\n \"excluded\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "07d779b3-a98b-44e7-914d-6fb0eff6cbc1", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "vat-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) VAT type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d9718896-7b22-48a0-aa67-0c5a96baad7a", "name": "Authenticated user is missing the `VER_TIPOSIVA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "vat-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) VAT type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "19c953f4-8545-494b-8422-3413bf4e36dd", "name": "VAT type not found", "originalRequest": { "url": { "path": [ "api", "v2", "vat-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) VAT type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "368e3e3e-c5ca-4c81-8798-6b518c20b044", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "vat-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) VAT type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0b2dcf07-54e4-4096-8cf8-6052c611ba9e", "name": "Update VAT type", "request": { "name": "Update VAT type", "description": { "content": "Full replacement. On update, null warehouseOverrides/associatedAccounts leaves existing children untouched; [] clears; non-empty list replaces. vatRatePurchase requires differentPurchaseSaleVat=true (header and each warehouse row).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "vat-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) VAT type ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"label\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"vatRate\": \"\",\n \"vatRatePurchase\": \"\",\n \"differentPurchaseSaleVat\": \"\",\n \"vatCategory\": \"\",\n \"nature303\": \"\",\n \"warehouseOverrides\": [\n {\n \"warehouseId\": \"\",\n \"vatRate\": \"\",\n \"vatRatePurchase\": \"\",\n \"differentPurchaseSaleVat\": \"\",\n \"useVatPriceAsNetPrice\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"vatRate\": \"\",\n \"vatRatePurchase\": \"\",\n \"differentPurchaseSaleVat\": \"\",\n \"useVatPriceAsNetPrice\": \"\"\n }\n ],\n \"associatedAccounts\": [\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n },\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n }\n ],\n \"exemptionType\": \"\",\n \"blockType\": \"\",\n \"surchargeTypeId\": \"\",\n \"excludeFromLedger\": \"\",\n \"commonVat\": \"\",\n \"excluded\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "f37fd33f-29a3-4143-9377-b07688449599", "name": "VAT type updated", "originalRequest": { "url": { "path": [ "api", "v2", "vat-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) VAT type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"label\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"vatRate\": \"\",\n \"vatRatePurchase\": \"\",\n \"differentPurchaseSaleVat\": \"\",\n \"vatCategory\": \"\",\n \"nature303\": \"\",\n \"warehouseOverrides\": [\n {\n \"warehouseId\": \"\",\n \"vatRate\": \"\",\n \"vatRatePurchase\": \"\",\n \"differentPurchaseSaleVat\": \"\",\n \"useVatPriceAsNetPrice\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"vatRate\": \"\",\n \"vatRatePurchase\": \"\",\n \"differentPurchaseSaleVat\": \"\",\n \"useVatPriceAsNetPrice\": \"\"\n }\n ],\n \"associatedAccounts\": [\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n },\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n }\n ],\n \"exemptionType\": \"\",\n \"blockType\": \"\",\n \"surchargeTypeId\": \"\",\n \"excludeFromLedger\": \"\",\n \"commonVat\": \"\",\n \"excluded\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"label\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"vatRate\": \"\",\n \"vatRatePurchase\": \"\",\n \"differentPurchaseSaleVat\": \"\",\n \"vatCategory\": \"\",\n \"nature303\": \"\",\n \"warehouseOverrides\": [\n {\n \"id\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"vatRate\": \"\",\n \"vatRatePurchase\": \"\",\n \"differentPurchaseSaleVat\": \"\",\n \"useVatPriceAsNetPrice\": \"\"\n },\n {\n \"id\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"vatRate\": \"\",\n \"vatRatePurchase\": \"\",\n \"differentPurchaseSaleVat\": \"\",\n \"useVatPriceAsNetPrice\": \"\"\n }\n ],\n \"associatedAccounts\": [\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n },\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n }\n ],\n \"exemptionType\": \"\",\n \"blockType\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"excludeFromLedger\": \"\",\n \"commonVat\": \"\",\n \"excluded\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "03a8bcdb-b563-48ee-afbd-239d8e4ac4a2", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "vat-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) VAT type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"label\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"vatRate\": \"\",\n \"vatRatePurchase\": \"\",\n \"differentPurchaseSaleVat\": \"\",\n \"vatCategory\": \"\",\n \"nature303\": \"\",\n \"warehouseOverrides\": [\n {\n \"warehouseId\": \"\",\n \"vatRate\": \"\",\n \"vatRatePurchase\": \"\",\n \"differentPurchaseSaleVat\": \"\",\n \"useVatPriceAsNetPrice\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"vatRate\": \"\",\n \"vatRatePurchase\": \"\",\n \"differentPurchaseSaleVat\": \"\",\n \"useVatPriceAsNetPrice\": \"\"\n }\n ],\n \"associatedAccounts\": [\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n },\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n }\n ],\n \"exemptionType\": \"\",\n \"blockType\": \"\",\n \"surchargeTypeId\": \"\",\n \"excludeFromLedger\": \"\",\n \"commonVat\": \"\",\n \"excluded\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "17957747-3b0f-476a-b407-a6811d121093", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "vat-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) VAT type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"label\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"vatRate\": \"\",\n \"vatRatePurchase\": \"\",\n \"differentPurchaseSaleVat\": \"\",\n \"vatCategory\": \"\",\n \"nature303\": \"\",\n \"warehouseOverrides\": [\n {\n \"warehouseId\": \"\",\n \"vatRate\": \"\",\n \"vatRatePurchase\": \"\",\n \"differentPurchaseSaleVat\": \"\",\n \"useVatPriceAsNetPrice\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"vatRate\": \"\",\n \"vatRatePurchase\": \"\",\n \"differentPurchaseSaleVat\": \"\",\n \"useVatPriceAsNetPrice\": \"\"\n }\n ],\n \"associatedAccounts\": [\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n },\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n }\n ],\n \"exemptionType\": \"\",\n \"blockType\": \"\",\n \"surchargeTypeId\": \"\",\n \"excludeFromLedger\": \"\",\n \"commonVat\": \"\",\n \"excluded\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e6f3dc45-7964-4813-90d5-c27eb9a9f121", "name": "Authenticated user is missing the `EDITAR_TIPOSIVA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "vat-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) VAT type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"label\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"vatRate\": \"\",\n \"vatRatePurchase\": \"\",\n \"differentPurchaseSaleVat\": \"\",\n \"vatCategory\": \"\",\n \"nature303\": \"\",\n \"warehouseOverrides\": [\n {\n \"warehouseId\": \"\",\n \"vatRate\": \"\",\n \"vatRatePurchase\": \"\",\n \"differentPurchaseSaleVat\": \"\",\n \"useVatPriceAsNetPrice\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"vatRate\": \"\",\n \"vatRatePurchase\": \"\",\n \"differentPurchaseSaleVat\": \"\",\n \"useVatPriceAsNetPrice\": \"\"\n }\n ],\n \"associatedAccounts\": [\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n },\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n }\n ],\n \"exemptionType\": \"\",\n \"blockType\": \"\",\n \"surchargeTypeId\": \"\",\n \"excludeFromLedger\": \"\",\n \"commonVat\": \"\",\n \"excluded\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "21873a0e-e6df-4eb6-81b0-6d3f125da7b6", "name": "VAT type not found", "originalRequest": { "url": { "path": [ "api", "v2", "vat-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) VAT type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"label\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"vatRate\": \"\",\n \"vatRatePurchase\": \"\",\n \"differentPurchaseSaleVat\": \"\",\n \"vatCategory\": \"\",\n \"nature303\": \"\",\n \"warehouseOverrides\": [\n {\n \"warehouseId\": \"\",\n \"vatRate\": \"\",\n \"vatRatePurchase\": \"\",\n \"differentPurchaseSaleVat\": \"\",\n \"useVatPriceAsNetPrice\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"vatRate\": \"\",\n \"vatRatePurchase\": \"\",\n \"differentPurchaseSaleVat\": \"\",\n \"useVatPriceAsNetPrice\": \"\"\n }\n ],\n \"associatedAccounts\": [\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n },\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n }\n ],\n \"exemptionType\": \"\",\n \"blockType\": \"\",\n \"surchargeTypeId\": \"\",\n \"excludeFromLedger\": \"\",\n \"commonVat\": \"\",\n \"excluded\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "871d4ed4-e298-4cd6-8b90-a6e8f9811b5b", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "vat-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) VAT type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"label\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"vatRate\": \"\",\n \"vatRatePurchase\": \"\",\n \"differentPurchaseSaleVat\": \"\",\n \"vatCategory\": \"\",\n \"nature303\": \"\",\n \"warehouseOverrides\": [\n {\n \"warehouseId\": \"\",\n \"vatRate\": \"\",\n \"vatRatePurchase\": \"\",\n \"differentPurchaseSaleVat\": \"\",\n \"useVatPriceAsNetPrice\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"vatRate\": \"\",\n \"vatRatePurchase\": \"\",\n \"differentPurchaseSaleVat\": \"\",\n \"useVatPriceAsNetPrice\": \"\"\n }\n ],\n \"associatedAccounts\": [\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n },\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n }\n ],\n \"exemptionType\": \"\",\n \"blockType\": \"\",\n \"surchargeTypeId\": \"\",\n \"excludeFromLedger\": \"\",\n \"commonVat\": \"\",\n \"excluded\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "75d6b80c-280c-4272-a948-9d3321126013", "name": "Delete VAT type", "request": { "name": "Delete VAT type", "description": { "content": "Deletes the VAT type. If-Match is accepted but ignored (TipoIVA is not versioned).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "vat-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) VAT type ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "3146041c-08d4-47d3-9656-c14a58b23625", "name": "VAT type deleted", "originalRequest": { "url": { "path": [ "api", "v2", "vat-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) VAT type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8c69ccd5-d3e5-4ee6-81fa-5323acbfbc67", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "vat-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) VAT type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b9427603-5b50-4c22-8537-9035fda1d3b3", "name": "Authenticated user is missing the `BORRAR_TIPOSIVA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "vat-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) VAT type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "396151c7-f12e-4d73-890a-328567fca97a", "name": "VAT type not found", "originalRequest": { "url": { "path": [ "api", "v2", "vat-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) VAT type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1f4d6fbd-0224-468a-bb69-8b1ffaf49803", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "vat-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) VAT type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "02038a4f-ff9b-4db7-9173-9c8d8fe45681", "name": "Merge-patch VAT type", "request": { "name": "Merge-patch VAT type", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "vat-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) VAT type ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "c6b1d963-2176-46bb-9039-37b0fed44c75", "name": "VAT type patched", "originalRequest": { "url": { "path": [ "api", "v2", "vat-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) VAT type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"label\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"vatRate\": \"\",\n \"vatRatePurchase\": \"\",\n \"differentPurchaseSaleVat\": \"\",\n \"vatCategory\": \"\",\n \"nature303\": \"\",\n \"warehouseOverrides\": [\n {\n \"id\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"vatRate\": \"\",\n \"vatRatePurchase\": \"\",\n \"differentPurchaseSaleVat\": \"\",\n \"useVatPriceAsNetPrice\": \"\"\n },\n {\n \"id\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"vatRate\": \"\",\n \"vatRatePurchase\": \"\",\n \"differentPurchaseSaleVat\": \"\",\n \"useVatPriceAsNetPrice\": \"\"\n }\n ],\n \"associatedAccounts\": [\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n },\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n }\n ],\n \"exemptionType\": \"\",\n \"blockType\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"excludeFromLedger\": \"\",\n \"commonVat\": \"\",\n \"excluded\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "906c30ab-58de-4dc9-8ff2-ff4a581580be", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details. Also returned for malformed merge-patch payloads.", "originalRequest": { "url": { "path": [ "api", "v2", "vat-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) VAT type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "795d538d-f102-40f6-9709-5fb7a50bb3e9", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "vat-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) VAT type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "aab1faf7-d78a-4cc4-b886-8db207d2cd7a", "name": "Authenticated user is missing the `EDITAR_TIPOSIVA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "vat-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) VAT type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "aec4a903-8386-4d13-bd32-bbf74478f2f4", "name": "VAT type not found", "originalRequest": { "url": { "path": [ "api", "v2", "vat-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) VAT type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "58008f24-ad23-4fc7-87b6-105a3dc047f1", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "vat-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) VAT type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "6bf829d5-a84d-4210-86f6-3db7c05a5718", "name": "List VAT types", "request": { "name": "List VAT types", "description": { "content": "Paginated list with optional RSQL filter and sort (default lastModifiedAt:desc). Child collections are omitted; use GET /{id} for warehouseOverrides and associatedAccounts.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "vat-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "3aecb265-0372-42f1-82e0-1eea4db0c563", "name": "Page of VAT types", "originalRequest": { "url": { "path": [ "api", "v2", "vat-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "26ba99d1-f8b6-497f-9cac-335d71238681", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "vat-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1863083e-3ea6-400e-b744-3fd03b601240", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "vat-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0625c84b-3c18-4c4e-8e69-9d01ba31e137", "name": "Authenticated user is missing the `VER_TIPOSIVA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "vat-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e0f63e5c-1537-4f2a-b795-a80eb2021b57", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "vat-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b7c38a42-76d5-4550-9269-7a67c5b0fa37", "name": "Create VAT type", "request": { "name": "Create VAT type", "description": { "content": "Persists via the internal commands gateway. warehouseOverrides/associatedAccounts: null leaves empty; [] clears; list replaces.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "vat-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"label\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"vatRate\": \"\",\n \"vatRatePurchase\": \"\",\n \"differentPurchaseSaleVat\": \"\",\n \"vatCategory\": \"\",\n \"nature303\": \"\",\n \"warehouseOverrides\": [\n {\n \"warehouseId\": \"\",\n \"vatRate\": \"\",\n \"vatRatePurchase\": \"\",\n \"differentPurchaseSaleVat\": \"\",\n \"useVatPriceAsNetPrice\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"vatRate\": \"\",\n \"vatRatePurchase\": \"\",\n \"differentPurchaseSaleVat\": \"\",\n \"useVatPriceAsNetPrice\": \"\"\n }\n ],\n \"associatedAccounts\": [\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n },\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n }\n ],\n \"exemptionType\": \"\",\n \"blockType\": \"\",\n \"surchargeTypeId\": \"\",\n \"excludeFromLedger\": \"\",\n \"commonVat\": \"\",\n \"excluded\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "be3b0427-8f84-4bfe-bd3c-4b3411e17a72", "name": "VAT type created", "originalRequest": { "url": { "path": [ "api", "v2", "vat-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"label\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"vatRate\": \"\",\n \"vatRatePurchase\": \"\",\n \"differentPurchaseSaleVat\": \"\",\n \"vatCategory\": \"\",\n \"nature303\": \"\",\n \"warehouseOverrides\": [\n {\n \"warehouseId\": \"\",\n \"vatRate\": \"\",\n \"vatRatePurchase\": \"\",\n \"differentPurchaseSaleVat\": \"\",\n \"useVatPriceAsNetPrice\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"vatRate\": \"\",\n \"vatRatePurchase\": \"\",\n \"differentPurchaseSaleVat\": \"\",\n \"useVatPriceAsNetPrice\": \"\"\n }\n ],\n \"associatedAccounts\": [\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n },\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n }\n ],\n \"exemptionType\": \"\",\n \"blockType\": \"\",\n \"surchargeTypeId\": \"\",\n \"excludeFromLedger\": \"\",\n \"commonVat\": \"\",\n \"excluded\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"label\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"vatRate\": \"\",\n \"vatRatePurchase\": \"\",\n \"differentPurchaseSaleVat\": \"\",\n \"vatCategory\": \"\",\n \"nature303\": \"\",\n \"warehouseOverrides\": [\n {\n \"id\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"vatRate\": \"\",\n \"vatRatePurchase\": \"\",\n \"differentPurchaseSaleVat\": \"\",\n \"useVatPriceAsNetPrice\": \"\"\n },\n {\n \"id\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"vatRate\": \"\",\n \"vatRatePurchase\": \"\",\n \"differentPurchaseSaleVat\": \"\",\n \"useVatPriceAsNetPrice\": \"\"\n }\n ],\n \"associatedAccounts\": [\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n },\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n }\n ],\n \"exemptionType\": \"\",\n \"blockType\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"excludeFromLedger\": \"\",\n \"commonVat\": \"\",\n \"excluded\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "06b9272d-6017-417f-8761-3eec6a85e7c9", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "vat-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"label\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"vatRate\": \"\",\n \"vatRatePurchase\": \"\",\n \"differentPurchaseSaleVat\": \"\",\n \"vatCategory\": \"\",\n \"nature303\": \"\",\n \"warehouseOverrides\": [\n {\n \"warehouseId\": \"\",\n \"vatRate\": \"\",\n \"vatRatePurchase\": \"\",\n \"differentPurchaseSaleVat\": \"\",\n \"useVatPriceAsNetPrice\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"vatRate\": \"\",\n \"vatRatePurchase\": \"\",\n \"differentPurchaseSaleVat\": \"\",\n \"useVatPriceAsNetPrice\": \"\"\n }\n ],\n \"associatedAccounts\": [\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n },\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n }\n ],\n \"exemptionType\": \"\",\n \"blockType\": \"\",\n \"surchargeTypeId\": \"\",\n \"excludeFromLedger\": \"\",\n \"commonVat\": \"\",\n \"excluded\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a1e09841-d8ab-4797-b989-10368d2b250b", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "vat-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"label\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"vatRate\": \"\",\n \"vatRatePurchase\": \"\",\n \"differentPurchaseSaleVat\": \"\",\n \"vatCategory\": \"\",\n \"nature303\": \"\",\n \"warehouseOverrides\": [\n {\n \"warehouseId\": \"\",\n \"vatRate\": \"\",\n \"vatRatePurchase\": \"\",\n \"differentPurchaseSaleVat\": \"\",\n \"useVatPriceAsNetPrice\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"vatRate\": \"\",\n \"vatRatePurchase\": \"\",\n \"differentPurchaseSaleVat\": \"\",\n \"useVatPriceAsNetPrice\": \"\"\n }\n ],\n \"associatedAccounts\": [\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n },\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n }\n ],\n \"exemptionType\": \"\",\n \"blockType\": \"\",\n \"surchargeTypeId\": \"\",\n \"excludeFromLedger\": \"\",\n \"commonVat\": \"\",\n \"excluded\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f95744b8-ee74-42a0-89e0-c74b79b85d1d", "name": "Authenticated user is missing the `CREAR_TIPOSIVA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "vat-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"label\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"vatRate\": \"\",\n \"vatRatePurchase\": \"\",\n \"differentPurchaseSaleVat\": \"\",\n \"vatCategory\": \"\",\n \"nature303\": \"\",\n \"warehouseOverrides\": [\n {\n \"warehouseId\": \"\",\n \"vatRate\": \"\",\n \"vatRatePurchase\": \"\",\n \"differentPurchaseSaleVat\": \"\",\n \"useVatPriceAsNetPrice\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"vatRate\": \"\",\n \"vatRatePurchase\": \"\",\n \"differentPurchaseSaleVat\": \"\",\n \"useVatPriceAsNetPrice\": \"\"\n }\n ],\n \"associatedAccounts\": [\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n },\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n }\n ],\n \"exemptionType\": \"\",\n \"blockType\": \"\",\n \"surchargeTypeId\": \"\",\n \"excludeFromLedger\": \"\",\n \"commonVat\": \"\",\n \"excluded\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6143254d-a250-4926-a222-0c3b88b238d4", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "vat-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"label\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"vatRate\": \"\",\n \"vatRatePurchase\": \"\",\n \"differentPurchaseSaleVat\": \"\",\n \"vatCategory\": \"\",\n \"nature303\": \"\",\n \"warehouseOverrides\": [\n {\n \"warehouseId\": \"\",\n \"vatRate\": \"\",\n \"vatRatePurchase\": \"\",\n \"differentPurchaseSaleVat\": \"\",\n \"useVatPriceAsNetPrice\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"vatRate\": \"\",\n \"vatRatePurchase\": \"\",\n \"differentPurchaseSaleVat\": \"\",\n \"useVatPriceAsNetPrice\": \"\"\n }\n ],\n \"associatedAccounts\": [\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n },\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n }\n ],\n \"exemptionType\": \"\",\n \"blockType\": \"\",\n \"surchargeTypeId\": \"\",\n \"excludeFromLedger\": \"\",\n \"commonVat\": \"\",\n \"excluded\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "new", "description": "", "item": [ { "id": "e4ab4b0e-2f46-4675-a428-4f4ed7fd17f5", "name": "Prototype a VAT type for a creation form", "request": { "name": "Prototype a VAT type for a creation form", "description": { "content": "Non-persisted defaults: current company, enabled=true, blockType=null. Optional JSON hints: companyId, surchargeTypeId, copyFromId.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "vat-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "10e915bb-d877-440a-94dd-885c80c5e4c1", "name": "VAT type prototype", "originalRequest": { "url": { "path": [ "api", "v2", "vat-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"label\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"vatRate\": \"\",\n \"vatRatePurchase\": \"\",\n \"differentPurchaseSaleVat\": \"\",\n \"vatCategory\": \"\",\n \"nature303\": \"\",\n \"warehouseOverrides\": [\n {\n \"id\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"vatRate\": \"\",\n \"vatRatePurchase\": \"\",\n \"differentPurchaseSaleVat\": \"\",\n \"useVatPriceAsNetPrice\": \"\"\n },\n {\n \"id\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"vatRate\": \"\",\n \"vatRatePurchase\": \"\",\n \"differentPurchaseSaleVat\": \"\",\n \"useVatPriceAsNetPrice\": \"\"\n }\n ],\n \"associatedAccounts\": [\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n },\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n }\n ],\n \"exemptionType\": \"\",\n \"blockType\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"excludeFromLedger\": \"\",\n \"commonVat\": \"\",\n \"excluded\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "56fe1976-cc02-404c-b148-a7a1188f0687", "name": "Hint references an unknown entity", "originalRequest": { "url": { "path": [ "api", "v2", "vat-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bdaf2fec-9404-423c-a9e2-0b7ddba1434f", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "vat-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bd0125ff-bb3b-41a3-aa41-ffe1e1645179", "name": "Authenticated user is missing the `CREAR_TIPOSIVA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "vat-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "458de1b8-d3ed-49d8-8a54-7ce4c99c8884", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "vat-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "users", "description": "", "item": [ { "name": "{userId}", "description": "", "item": [ { "name": "preferences", "description": "", "item": [ { "id": "c14fd07d-269a-4cbe-84c8-9f76de9d8840", "name": "Get a user's preferences", "request": { "name": "Get a user's preferences", "description": { "content": "Returns the preferences of the given user. Permitted when the caller is the same user, or holds `VER_USUARIOSPREF`.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "users", ":userId", "preferences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "userId", "disabled": false, "description": { "content": "(Required) Identifier of the user whose preferences are requested.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "2cd0096c-c784-407e-b0e7-d135698d55fa", "name": "Preferences", "originalRequest": { "url": { "path": [ "api", "v2", "users", ":userId", "preferences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identifier of the user whose preferences are requested.", "type": "text/plain" }, "type": "any", "value": "", "key": "userId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"userId\": \"\",\n \"username\": \"\",\n \"viewTemplates\": [\n {\n \"featureType\": \"\",\n \"viewId\": \"\"\n },\n {\n \"featureType\": \"\",\n \"viewId\": \"\"\n }\n ],\n \"screenTemplates\": [\n {\n \"screenKey\": \"\",\n \"templateId\": \"\"\n },\n {\n \"screenKey\": \"\",\n \"templateId\": \"\"\n }\n ],\n \"expandedListings\": [\n \"\",\n \"\"\n ],\n \"defaultDashboardId\": \"\",\n \"businessContext\": {\n \"companies\": [\n {\n \"id\": \"\",\n \"label\": \"\"\n },\n {\n \"id\": \"\",\n \"label\": \"\"\n }\n ],\n \"warehouses\": [\n {\n \"id\": \"\",\n \"label\": \"\"\n },\n {\n \"id\": \"\",\n \"label\": \"\"\n }\n ],\n \"currentCompanyId\": \"\",\n \"currentWarehouseId\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3347c0c0-160c-4cfd-87fe-6def35483849", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "users", ":userId", "preferences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identifier of the user whose preferences are requested.", "type": "text/plain" }, "type": "any", "value": "", "key": "userId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1aa49d74-2409-4e50-ae54-c756912af5d5", "name": "Caller is not the target user and is missing `VER_USUARIOSPREF`", "originalRequest": { "url": { "path": [ "api", "v2", "users", ":userId", "preferences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identifier of the user whose preferences are requested.", "type": "text/plain" }, "type": "any", "value": "", "key": "userId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9a6b2e47-1986-4ba0-9f85-c1c0b2054980", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "users", ":userId", "preferences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identifier of the user whose preferences are requested.", "type": "text/plain" }, "type": "any", "value": "", "key": "userId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "08e7a5f4-1257-4d7e-908e-82527ddd7300", "name": "Update a user's preferences", "request": { "name": "Update a user's preferences", "description": { "content": "Updates the preferences of the given user. Permitted when the caller is the same user, or holds `EDITAR_USUARIOSPREF`.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "users", ":userId", "preferences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "userId", "disabled": false, "description": { "content": "(Required) Identifier of the user whose preferences are updated.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"viewTemplates\": [\n {\n \"featureType\": \"\",\n \"viewId\": \"\"\n },\n {\n \"featureType\": \"\",\n \"viewId\": \"\"\n }\n ],\n \"screenTemplates\": [\n {\n \"screenKey\": \"\",\n \"templateId\": \"\"\n },\n {\n \"screenKey\": \"\",\n \"templateId\": \"\"\n }\n ],\n \"expandedListings\": [\n \"\",\n \"\"\n ],\n \"defaultDashboardId\": \"\",\n \"businessContext\": {\n \"companies\": [\n {\n \"id\": \"\",\n \"label\": \"\"\n },\n {\n \"id\": \"\",\n \"label\": \"\"\n }\n ],\n \"warehouses\": [\n {\n \"id\": \"\",\n \"label\": \"\"\n },\n {\n \"id\": \"\",\n \"label\": \"\"\n }\n ],\n \"currentCompanyId\": \"\",\n \"currentWarehouseId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "e6c5b065-92cb-461b-aa14-5d79d74ae9c9", "name": "Preferences", "originalRequest": { "url": { "path": [ "api", "v2", "users", ":userId", "preferences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identifier of the user whose preferences are updated.", "type": "text/plain" }, "type": "any", "value": "", "key": "userId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"viewTemplates\": [\n {\n \"featureType\": \"\",\n \"viewId\": \"\"\n },\n {\n \"featureType\": \"\",\n \"viewId\": \"\"\n }\n ],\n \"screenTemplates\": [\n {\n \"screenKey\": \"\",\n \"templateId\": \"\"\n },\n {\n \"screenKey\": \"\",\n \"templateId\": \"\"\n }\n ],\n \"expandedListings\": [\n \"\",\n \"\"\n ],\n \"defaultDashboardId\": \"\",\n \"businessContext\": {\n \"companies\": [\n {\n \"id\": \"\",\n \"label\": \"\"\n },\n {\n \"id\": \"\",\n \"label\": \"\"\n }\n ],\n \"warehouses\": [\n {\n \"id\": \"\",\n \"label\": \"\"\n },\n {\n \"id\": \"\",\n \"label\": \"\"\n }\n ],\n \"currentCompanyId\": \"\",\n \"currentWarehouseId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"userId\": \"\",\n \"username\": \"\",\n \"viewTemplates\": [\n {\n \"featureType\": \"\",\n \"viewId\": \"\"\n },\n {\n \"featureType\": \"\",\n \"viewId\": \"\"\n }\n ],\n \"screenTemplates\": [\n {\n \"screenKey\": \"\",\n \"templateId\": \"\"\n },\n {\n \"screenKey\": \"\",\n \"templateId\": \"\"\n }\n ],\n \"expandedListings\": [\n \"\",\n \"\"\n ],\n \"defaultDashboardId\": \"\",\n \"businessContext\": {\n \"companies\": [\n {\n \"id\": \"\",\n \"label\": \"\"\n },\n {\n \"id\": \"\",\n \"label\": \"\"\n }\n ],\n \"warehouses\": [\n {\n \"id\": \"\",\n \"label\": \"\"\n },\n {\n \"id\": \"\",\n \"label\": \"\"\n }\n ],\n \"currentCompanyId\": \"\",\n \"currentWarehouseId\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d2c4db6c-7af6-486e-9e4f-725513f74990", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "users", ":userId", "preferences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identifier of the user whose preferences are updated.", "type": "text/plain" }, "type": "any", "value": "", "key": "userId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"viewTemplates\": [\n {\n \"featureType\": \"\",\n \"viewId\": \"\"\n },\n {\n \"featureType\": \"\",\n \"viewId\": \"\"\n }\n ],\n \"screenTemplates\": [\n {\n \"screenKey\": \"\",\n \"templateId\": \"\"\n },\n {\n \"screenKey\": \"\",\n \"templateId\": \"\"\n }\n ],\n \"expandedListings\": [\n \"\",\n \"\"\n ],\n \"defaultDashboardId\": \"\",\n \"businessContext\": {\n \"companies\": [\n {\n \"id\": \"\",\n \"label\": \"\"\n },\n {\n \"id\": \"\",\n \"label\": \"\"\n }\n ],\n \"warehouses\": [\n {\n \"id\": \"\",\n \"label\": \"\"\n },\n {\n \"id\": \"\",\n \"label\": \"\"\n }\n ],\n \"currentCompanyId\": \"\",\n \"currentWarehouseId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2d9c1659-6699-4489-a77e-a8603b161307", "name": "Caller is not the target user and is missing `EDITAR_USUARIOSPREF`", "originalRequest": { "url": { "path": [ "api", "v2", "users", ":userId", "preferences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identifier of the user whose preferences are updated.", "type": "text/plain" }, "type": "any", "value": "", "key": "userId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"viewTemplates\": [\n {\n \"featureType\": \"\",\n \"viewId\": \"\"\n },\n {\n \"featureType\": \"\",\n \"viewId\": \"\"\n }\n ],\n \"screenTemplates\": [\n {\n \"screenKey\": \"\",\n \"templateId\": \"\"\n },\n {\n \"screenKey\": \"\",\n \"templateId\": \"\"\n }\n ],\n \"expandedListings\": [\n \"\",\n \"\"\n ],\n \"defaultDashboardId\": \"\",\n \"businessContext\": {\n \"companies\": [\n {\n \"id\": \"\",\n \"label\": \"\"\n },\n {\n \"id\": \"\",\n \"label\": \"\"\n }\n ],\n \"warehouses\": [\n {\n \"id\": \"\",\n \"label\": \"\"\n },\n {\n \"id\": \"\",\n \"label\": \"\"\n }\n ],\n \"currentCompanyId\": \"\",\n \"currentWarehouseId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f24445bd-3258-44c3-89af-b94c520dd27a", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "users", ":userId", "preferences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identifier of the user whose preferences are updated.", "type": "text/plain" }, "type": "any", "value": "", "key": "userId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"viewTemplates\": [\n {\n \"featureType\": \"\",\n \"viewId\": \"\"\n },\n {\n \"featureType\": \"\",\n \"viewId\": \"\"\n }\n ],\n \"screenTemplates\": [\n {\n \"screenKey\": \"\",\n \"templateId\": \"\"\n },\n {\n \"screenKey\": \"\",\n \"templateId\": \"\"\n }\n ],\n \"expandedListings\": [\n \"\",\n \"\"\n ],\n \"defaultDashboardId\": \"\",\n \"businessContext\": {\n \"companies\": [\n {\n \"id\": \"\",\n \"label\": \"\"\n },\n {\n \"id\": \"\",\n \"label\": \"\"\n }\n ],\n \"warehouses\": [\n {\n \"id\": \"\",\n \"label\": \"\"\n },\n {\n \"id\": \"\",\n \"label\": \"\"\n }\n ],\n \"currentCompanyId\": \"\",\n \"currentWarehouseId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "{id}", "description": "", "item": [ { "name": "sessions", "description": "", "item": [ { "name": "{familyId}", "description": "", "item": [ { "name": "close", "description": "", "item": [ { "id": "bfa640d3-32c1-4662-8576-a104c744e81d", "name": "Close a session", "request": { "name": "Close a session", "description": {}, "url": { "path": [ "api", "v2", "users", ":id", "sessions", ":familyId", "close" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "familyId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "67a0aaf8-b4c3-47d9-8b33-9bd0b9e51edf", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "users", ":id", "sessions", ":familyId", "close" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "familyId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "42910ebe-ea54-4a04-b639-30c979e4b895", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "users", ":id", "sessions", ":familyId", "close" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "familyId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "close-all", "description": "", "item": [ { "id": "90cf10ab-6193-47c4-a511-f68b2be5669c", "name": "Close all sessions", "request": { "name": "Close all sessions", "description": {}, "url": { "path": [ "api", "v2", "users", ":id", "sessions", "close-all" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "504de249-ec8f-44ad-9c8f-7b2b09a5c60f", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "users", ":id", "sessions", "close-all" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "979200c3-6b5b-4a98-9c64-89eda79c941a", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "users", ":id", "sessions", "close-all" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "permissions", "description": "", "item": [ { "name": "save-as-role", "description": "", "item": [ { "id": "f5d17707-3f5d-4609-a206-5bc513b57434", "name": "Save the customized permission set as a new ERP role and assign it", "request": { "name": "Save the customized permission set as a new ERP role and assign it", "description": { "content": "Creates a core_role from the user's private permission copy (name must be unique in the tenant) and assigns it to the user.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "users", ":id", "permissions", "save-as-role" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"color\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "b4edc39e-7636-467d-918f-ee6c5735263d", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "users", ":id", "permissions", "save-as-role" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"color\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5a061dda-9e1d-492f-b4ba-6761797db497", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "users", ":id", "permissions", "save-as-role" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"color\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "templates", "description": "", "item": [ { "name": "{featureType}", "description": "", "item": [ { "id": "6346986f-ce74-4730-ae10-a261ae21a502", "name": "Change the list template applied to a feature for this user", "request": { "name": "Change the list template applied to a feature for this user", "description": { "content": "listTemplate is a named view_plantilla id (shared, or private of the TARGET user) or 'default' to clear the selection.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "users", ":id", "permissions", "templates", ":featureType" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "featureType", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"listTemplate\": \"default\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "a175f7df-5d14-46e0-b056-3631e4973d2d", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "users", ":id", "permissions", "templates", ":featureType" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "featureType" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"listTemplate\": \"default\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c88fbfe0-b770-453b-89a4-9572e096340a", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "users", ":id", "permissions", "templates", ":featureType" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "featureType" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"listTemplate\": \"default\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "modules", "description": "", "item": [ { "name": "{moduleId}", "description": "", "item": [ { "id": "c1696cc2-aec8-4ee3-9697-035aa16b5bf4", "name": "Enable/disable a module (customized users only)", "request": { "name": "Enable/disable a module (customized users only)", "description": {}, "url": { "path": [ "api", "v2", "users", ":id", "permissions", "modules", ":moduleId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "moduleId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"enabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "ff050b39-67c1-4239-8825-b9a50ad9bba8", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "users", ":id", "permissions", "modules", ":moduleId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "moduleId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"enabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e405fb87-0bbd-4ae3-97b0-813086f6ca2f", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "users", ":id", "permissions", "modules", ":moduleId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "moduleId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"enabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "matrix", "description": "", "item": [ { "name": "{entryId}", "description": "", "item": [ { "id": "5198235f-ded0-44d7-82ed-f9d469871374", "name": "Toggle one matrix cell (customized users only)", "request": { "name": "Toggle one matrix cell (customized users only)", "description": { "content": "entryId = SubModule enum name (parent row) or PermissionEnum name (OTROS child row); actionId = ALL or a TipoPermiso. Identifiers are whitelisted against the gesmo-permissions enums. Anti-escalation: granting requires the caller to hold the permission; revoking is unrestricted.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "users", ":id", "permissions", "matrix", ":entryId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "entryId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"actionId\": \"JORK_THYCUQRB_PNIEPDUVVITLHKFOWT_C\",\n \"enabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "55b2058b-c153-4c31-a804-0c81f84c6c00", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "users", ":id", "permissions", "matrix", ":entryId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "entryId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"actionId\": \"JORK_THYCUQRB_PNIEPDUVVITLHKFOWT_C\",\n \"enabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e1e08f9e-fe8e-43ef-b480-d8b3c9a9016c", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "users", ":id", "permissions", "matrix", ":entryId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "entryId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"actionId\": \"JORK_THYCUQRB_PNIEPDUVVITLHKFOWT_C\",\n \"enabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "customization", "description": "", "item": [ { "id": "6a21f16b-9e2f-43a6-946a-6008a00a8fa0", "name": "Customize (copy role ÔåÆ private set) or assign an ERP role", "request": { "name": "Customize (copy role ÔåÆ private set) or assign an ERP role", "description": { "content": "customized=true copies the role's permissions into an editable private set and detaches the role; customized=false assigns the role. Anti-escalation: the caller can only assign/copy roles whose permissions they hold themselves.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "users", ":id", "permissions", "customization" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"customized\": \"\",\n \"roleId\": \"069854607390270796\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "0e15d6ea-bada-47f3-a1c3-5126bc759504", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "users", ":id", "permissions", "customization" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"customized\": \"\",\n \"roleId\": \"069854607390270796\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "81ea1d0a-9d30-4c3a-b725-bd57199a86fc", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "users", ":id", "permissions", "customization" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"customized\": \"\",\n \"roleId\": \"069854607390270796\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "21d09dd5-ca10-4a08-9fac-494c93d008d4", "name": "ERP permission matrix (role-inherited or customized)", "request": { "name": "ERP permission matrix (role-inherited or customized)", "description": { "content": "Projects the tenant's ERP permission model (core_role / core_usuario_permiso) onto the matrix contract: Module sections, SubModule rows, TipoPermiso columns, plus the per-feature list-template selection. Labels are stable i18n keys; the SPA translates them. Changes apply to live sessions on the next token refresh.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "users", ":id", "permissions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "9d1b2646-8589-4c16-8d46-eb6c1ebb48b4", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "users", ":id", "permissions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "69c57563-c0b4-42ed-bd53-d8924a26f629", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "users", ":id", "permissions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "password", "description": "", "item": [ { "name": "reset", "description": "", "item": [ { "id": "834b3971-bb94-48d6-a9b4-d3c9da5ed6c7", "name": "Reset password (force change on next login)", "request": { "name": "Reset password (force change on next login)", "description": {}, "url": { "path": [ "api", "v2", "users", ":id", "password", "reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "549ff30c-81bb-45ea-bea2-f21834494b81", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "users", ":id", "password", "reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "57d6d048-410e-43f3-be32-d3dbc810552c", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "users", ":id", "password", "reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "force-change", "description": "", "item": [ { "id": "122d1df3-3483-4028-9ad5-8567a36c183d", "name": "Force password change on next login", "request": { "name": "Force password change on next login", "description": {}, "url": { "path": [ "api", "v2", "users", ":id", "password", "force-change" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "49aa1a3f-ee55-4571-b780-e6e4c8083ae7", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "users", ":id", "password", "force-change" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0d3e8088-35a5-48f2-8a7d-6ba24720c6f0", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "users", ":id", "password", "force-change" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "ip-restrictions", "description": "", "item": [ { "name": "ips", "description": "", "item": [ { "id": "693a1d07-7d6c-418d-a6ae-db5e4aaaea71", "name": "Authorize an IP", "request": { "name": "Authorize an IP", "description": {}, "url": { "path": [ "api", "v2", "users", ":id", "ip-restrictions", "ips" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ip\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "cf1d18a7-1cb3-4233-a43f-3ce3bc443957", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "users", ":id", "ip-restrictions", "ips" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ip\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bf66d294-584a-4534-a2da-1b61f3df0898", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "users", ":id", "ip-restrictions", "ips" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ip\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{ipId}", "description": "", "item": [ { "id": "52df8fd3-d1fd-4d99-aca9-732631b2461d", "name": "Remove an authorized IP", "request": { "name": "Remove an authorized IP", "description": {}, "url": { "path": [ "api", "v2", "users", ":id", "ip-restrictions", "ips", ":ipId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "ipId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "0576fd4f-730c-4b7c-bcd4-72baaaf8f847", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "users", ":id", "ip-restrictions", "ips", ":ipId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ipId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "14dbfb35-e1a1-4e9f-b7cd-57e75f4255bb", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "users", ":id", "ip-restrictions", "ips", ":ipId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ipId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "id": "850b08cf-f3ad-4fa9-9bd2-341d158c65ff", "name": "Enable/disable IP restrictions", "request": { "name": "Enable/disable IP restrictions", "description": {}, "url": { "path": [ "api", "v2", "users", ":id", "ip-restrictions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"enabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "b85e9dc0-374c-4c71-a219-9fa1cdd5303d", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "users", ":id", "ip-restrictions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"enabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "60d76557-b1e0-4453-8c97-c038462bd55b", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "users", ":id", "ip-restrictions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"enabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "7015fecb-1725-4b22-8484-f5d7c82f019b", "name": "Get a user", "request": { "name": "Get a user", "description": {}, "url": { "path": [ "api", "v2", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "540adf20-2b16-4398-9950-70920a155df9", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5e381d02-db72-4053-b8d3-3505d6925f8e", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3d18b165-f852-40b5-91ea-6aa244bd4f7f", "name": "Delete a user", "request": { "name": "Delete a user", "description": {}, "url": { "path": [ "api", "v2", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "a0a8f8bf-1e6d-41ae-80e7-5ceb5d405bbd", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "916911a9-a331-41b3-aef3-9781a8de06cd", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1a1faa8d-ae10-4594-a703-132b6da2193d", "name": "Update a user (merge-patch)", "request": { "name": "Update a user (merge-patch)", "description": {}, "url": { "path": [ "api", "v2", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"key_0\": true,\n \"key_1\": 6062\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "ce0334b6-808c-4a76-891f-dbbf1cfd2fc6", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"key_0\": true,\n \"key_1\": 6062\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "37bb4104-8946-49c3-a318-a134545d7d97", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"key_0\": true,\n \"key_1\": 6062\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "devices", "description": "", "item": [ { "name": "{deviceId}", "description": "", "item": [ { "id": "7f948623-7487-40e0-97d9-1020583da9ff", "name": "Revoke a device", "request": { "name": "Revoke a device", "description": {}, "url": { "path": [ "api", "v2", "users", ":id", "devices", ":deviceId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "deviceId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "b1418b40-3f9c-49e9-b543-08b5c0cad2e7", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "users", ":id", "devices", ":deviceId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "deviceId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9dbc0572-2b17-49e6-b1dd-5af22700ade0", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "users", ":id", "devices", ":deviceId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "deviceId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7dc767c9-9a58-469a-9f4c-f135b58f92d6", "name": "Update a device (trust/active)", "request": { "name": "Update a device (trust/active)", "description": {}, "url": { "path": [ "api", "v2", "users", ":id", "devices", ":deviceId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "deviceId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"trusted\": \"\",\n \"active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "2aa7b425-ced9-4f24-8748-fa62dd6c27d9", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "users", ":id", "devices", ":deviceId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "deviceId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"trusted\": \"\",\n \"active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b3dd8096-1581-4c83-8f13-ba941d63b74a", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "users", ":id", "devices", ":deviceId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "deviceId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"trusted\": \"\",\n \"active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "access-authentication", "description": "", "item": [ { "id": "d72cf39e-40cc-432a-8bb8-8f9d5eef004c", "name": "Access & authentication view (password, IP, sessions, devices, events)", "request": { "name": "Access & authentication view (password, IP, sessions, devices, events)", "description": {}, "url": { "path": [ "api", "v2", "users", ":id", "access-authentication" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "a9fb482f-6bfd-409b-b7e9-7de3f855284f", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "users", ":id", "access-authentication" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f8fc9ec2-6819-4ee7-916f-3a7a861bd63c", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "users", ":id", "access-authentication" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "id": "f2370d21-5c16-4ce4-9c0c-a48b8eff12e5", "name": "List users (paginated)", "request": { "name": "List users (paginated)", "description": {}, "url": { "path": [ "api", "v2", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "roleId", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "active", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "5e94ec56-03c0-4122-b4db-3b61661d1ccf", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "roleId", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "active", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4574dff9-83da-4114-afc0-d5f1b82b4964", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "roleId", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "active", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "summary", "description": "", "item": [ { "id": "05d8d47f-feda-4447-b29f-4d5f3f1cf20d", "name": "Users header counters", "request": { "name": "Users header counters", "description": {}, "url": { "path": [ "api", "v2", "users", "summary" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "321a12cf-94d8-4b04-8ead-365631ded11e", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "users", "summary" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7827957c-3cae-4d2b-a495-30719ef8c26f", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "users", "summary" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "companies", "description": "", "item": [ { "id": "6ba2e55d-0e80-4440-bb12-925d8dcb3014", "name": "Company/branch options for the invite dialog", "request": { "name": "Company/branch options for the invite dialog", "description": {}, "url": { "path": [ "api", "v2", "users", "companies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "7d37bb2c-c97c-4089-8084-a7249f8df2ba", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "users", "companies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b50dd343-8de9-4e0b-8879-e99a40022a3e", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "users", "companies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "solutions", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "3c818295-4eba-4ef4-b1f0-873df170dfe9", "name": "Get solution by ID", "request": { "name": "Get solution by ID", "description": { "content": "Returns a single claim solution configuration by its primary key, including synthesized {@code actions} from legacy permission flags.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "solutions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Solution ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "fa3fc911-4353-40bc-a755-bd1bc3cd705d", "name": "Solution found", "originalRequest": { "url": { "path": [ "api", "v2", "solutions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Solution ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"claimTypeId\": \"\",\n \"claimTypeName\": \"\",\n \"solutionTypeId\": \"\",\n \"solutionTypeName\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"employeeLevel\": \"\",\n \"allowsLensChange\": \"\",\n \"allowsRefund\": \"\",\n \"allowsPin\": \"\",\n \"allowsCreditNote\": \"\",\n \"allowsWarranty\": \"\",\n \"allowsOrder\": \"\",\n \"allowsOrderEdit\": \"\",\n \"orderTypeId\": \"\",\n \"orderTypeName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c086018d-fdc4-43cd-a83a-65cc5aac0416", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "solutions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Solution ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d36b4ccf-f974-4840-9bfa-8294a047b03e", "name": "Authenticated user is missing the `VER_RECLAMOTIPORECLAMO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "solutions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Solution ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "57a5123e-5949-41a5-9226-6b519dfeb5c9", "name": "Solution not found", "originalRequest": { "url": { "path": [ "api", "v2", "solutions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Solution ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "66b8bcdf-2c29-44cf-a046-f13cf0ebe0be", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "solutions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Solution ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e7728f18-4cff-48f8-bc11-5466a7a91c77", "name": "Update solution", "request": { "name": "Update solution", "description": { "content": "Full replacement of an existing claim solution configuration. Send the `If-Match` header for optimistic concurrency (accepted but ignored ÔÇö not versioned).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "solutions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Solution ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"solutionTypeId\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"employeeLevel\": \"\",\n \"allowsLensChange\": \"\",\n \"allowsRefund\": \"\",\n \"allowsPin\": \"\",\n \"allowsCreditNote\": \"\",\n \"allowsWarranty\": \"\",\n \"allowsOrder\": \"\",\n \"allowsOrderEdit\": \"\",\n \"orderTypeId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "d449617d-4e9c-41d9-b602-e327c66feb01", "name": "Solution updated", "originalRequest": { "url": { "path": [ "api", "v2", "solutions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Solution ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"solutionTypeId\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"employeeLevel\": \"\",\n \"allowsLensChange\": \"\",\n \"allowsRefund\": \"\",\n \"allowsPin\": \"\",\n \"allowsCreditNote\": \"\",\n \"allowsWarranty\": \"\",\n \"allowsOrder\": \"\",\n \"allowsOrderEdit\": \"\",\n \"orderTypeId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"claimTypeId\": \"\",\n \"claimTypeName\": \"\",\n \"solutionTypeId\": \"\",\n \"solutionTypeName\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"employeeLevel\": \"\",\n \"allowsLensChange\": \"\",\n \"allowsRefund\": \"\",\n \"allowsPin\": \"\",\n \"allowsCreditNote\": \"\",\n \"allowsWarranty\": \"\",\n \"allowsOrder\": \"\",\n \"allowsOrderEdit\": \"\",\n \"orderTypeId\": \"\",\n \"orderTypeName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bf80ace6-6e93-45a7-9f0b-c7533ecba64c", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "solutions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Solution ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"solutionTypeId\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"employeeLevel\": \"\",\n \"allowsLensChange\": \"\",\n \"allowsRefund\": \"\",\n \"allowsPin\": \"\",\n \"allowsCreditNote\": \"\",\n \"allowsWarranty\": \"\",\n \"allowsOrder\": \"\",\n \"allowsOrderEdit\": \"\",\n \"orderTypeId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "80bb74f2-a4f5-4fa9-85d9-f9a0ca2a25f7", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "solutions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Solution ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"solutionTypeId\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"employeeLevel\": \"\",\n \"allowsLensChange\": \"\",\n \"allowsRefund\": \"\",\n \"allowsPin\": \"\",\n \"allowsCreditNote\": \"\",\n \"allowsWarranty\": \"\",\n \"allowsOrder\": \"\",\n \"allowsOrderEdit\": \"\",\n \"orderTypeId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "28ea1be8-5c57-4525-9e6d-9ff5a37f7fd1", "name": "Authenticated user is missing the `EDITAR_RECLAMOTIPORECLAMO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "solutions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Solution ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"solutionTypeId\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"employeeLevel\": \"\",\n \"allowsLensChange\": \"\",\n \"allowsRefund\": \"\",\n \"allowsPin\": \"\",\n \"allowsCreditNote\": \"\",\n \"allowsWarranty\": \"\",\n \"allowsOrder\": \"\",\n \"allowsOrderEdit\": \"\",\n \"orderTypeId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bb5fa7ba-970e-4790-8045-0c7ab36299dd", "name": "Solution not found", "originalRequest": { "url": { "path": [ "api", "v2", "solutions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Solution ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"solutionTypeId\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"employeeLevel\": \"\",\n \"allowsLensChange\": \"\",\n \"allowsRefund\": \"\",\n \"allowsPin\": \"\",\n \"allowsCreditNote\": \"\",\n \"allowsWarranty\": \"\",\n \"allowsOrder\": \"\",\n \"allowsOrderEdit\": \"\",\n \"orderTypeId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "69d59304-ca25-4aa7-a740-447310b05b67", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "solutions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Solution ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"solutionTypeId\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"employeeLevel\": \"\",\n \"allowsLensChange\": \"\",\n \"allowsRefund\": \"\",\n \"allowsPin\": \"\",\n \"allowsCreditNote\": \"\",\n \"allowsWarranty\": \"\",\n \"allowsOrder\": \"\",\n \"allowsOrderEdit\": \"\",\n \"orderTypeId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b6ef1275-618f-4ace-bc56-28ab8aab7fa8", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "solutions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Solution ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"solutionTypeId\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"employeeLevel\": \"\",\n \"allowsLensChange\": \"\",\n \"allowsRefund\": \"\",\n \"allowsPin\": \"\",\n \"allowsCreditNote\": \"\",\n \"allowsWarranty\": \"\",\n \"allowsOrder\": \"\",\n \"allowsOrderEdit\": \"\",\n \"orderTypeId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "539a7d14-d5ad-4149-a3af-3e9ce40d3abe", "name": "Delete solution", "request": { "name": "Delete solution", "description": { "content": "Deletes a claim solution configuration. Send the `If-Match` header with the current ETag (accepted but ignored ÔÇö not versioned).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "solutions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Solution ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "7939e9b6-6539-4120-9b37-54c9f20ab958", "name": "Solution deleted", "originalRequest": { "url": { "path": [ "api", "v2", "solutions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Solution ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8d717e96-2cd9-4250-84b8-df09c2f24df8", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "solutions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Solution ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d48aadb3-edd7-4326-9424-23c43abe6080", "name": "Authenticated user is missing the `BORRAR_RECLAMOTIPORECLAMO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "solutions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Solution ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "18361f0f-f777-4194-9bb5-ca81a073b1a1", "name": "Solution not found", "originalRequest": { "url": { "path": [ "api", "v2", "solutions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Solution ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5ab85420-5cfd-411b-9e85-095e99b9f52e", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "solutions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Solution ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c69cc204-e3e8-4c7f-8697-6a1b21368123", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "solutions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Solution ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "76c7f3ee-f4dd-4fb9-9edb-a4dba8edd402", "name": "Merge-patch solution", "request": { "name": "Merge-patch solution", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "solutions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Solution ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "f0c31350-62f4-46ce-823d-fc4607d3ae82", "name": "Solution patched", "originalRequest": { "url": { "path": [ "api", "v2", "solutions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Solution ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"claimTypeId\": \"\",\n \"claimTypeName\": \"\",\n \"solutionTypeId\": \"\",\n \"solutionTypeName\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"employeeLevel\": \"\",\n \"allowsLensChange\": \"\",\n \"allowsRefund\": \"\",\n \"allowsPin\": \"\",\n \"allowsCreditNote\": \"\",\n \"allowsWarranty\": \"\",\n \"allowsOrder\": \"\",\n \"allowsOrderEdit\": \"\",\n \"orderTypeId\": \"\",\n \"orderTypeName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "be4b8a82-2785-43b8-b2a0-47b2fa612bff", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details. Also returned for malformed merge-patch payloads.", "originalRequest": { "url": { "path": [ "api", "v2", "solutions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Solution ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "50a6f52d-0ca2-4a99-a459-a5e7879e951f", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "solutions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Solution ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4ba3b128-6c76-4e74-aba0-88ba81617c14", "name": "Authenticated user is missing the `EDITAR_RECLAMOTIPORECLAMO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "solutions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Solution ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "394ac191-028d-41a1-aa4d-f2719e00ffdb", "name": "Solution not found", "originalRequest": { "url": { "path": [ "api", "v2", "solutions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Solution ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "720e58df-1610-438f-8231-8253754923bd", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "solutions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Solution ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5224f6f7-2ec5-4144-9a7a-ec2ebe4cb396", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "solutions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Solution ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "4d4c95d7-fd64-4c14-a24c-2d0f943f2614", "name": "List solutions", "request": { "name": "List solutions", "description": { "content": "Returns a paginated list of claim solution configurations with envelope `{data, totalCount, skip, limit, hasMore}`. Supports optional RSQL `filter`, `sort` (default `title:asc`), `skip`/`limit` pagination and `modifiedAfter`/`modifiedBefore` bookends.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "solutions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "title:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "353e3be6-d568-472f-989b-69d7b9dff322", "name": "Page of solutions", "originalRequest": { "url": { "path": [ "api", "v2", "solutions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "title:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4a68eb61-fa43-466e-8226-dd6c1335b070", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "solutions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "title:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "708aee27-1e7d-49c1-be0c-a62f20eb4e27", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "solutions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "title:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "57595665-5150-48ce-801f-42ab93ef11c9", "name": "Authenticated user is missing the `VER_RECLAMOTIPORECLAMO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "solutions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "title:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2f617b3f-789e-45e5-ab95-4275144dfde5", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "solutions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "title:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f896878c-2e6c-4cf7-97b6-a2a3fafedfd8", "name": "Create solution", "request": { "name": "Create solution", "description": { "content": "Creates a new claim solution configuration. Business logic runs in the legacy WAR via the internal commands gateway. Requires `claimTypeId` and `solutionTypeId`.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "solutions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"solutionTypeId\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"employeeLevel\": \"\",\n \"allowsLensChange\": \"\",\n \"allowsRefund\": \"\",\n \"allowsPin\": \"\",\n \"allowsCreditNote\": \"\",\n \"allowsWarranty\": \"\",\n \"allowsOrder\": \"\",\n \"allowsOrderEdit\": \"\",\n \"orderTypeId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "bbe1e536-8273-4f31-bc4c-8156b79bfc7a", "name": "Solution created", "originalRequest": { "url": { "path": [ "api", "v2", "solutions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"solutionTypeId\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"employeeLevel\": \"\",\n \"allowsLensChange\": \"\",\n \"allowsRefund\": \"\",\n \"allowsPin\": \"\",\n \"allowsCreditNote\": \"\",\n \"allowsWarranty\": \"\",\n \"allowsOrder\": \"\",\n \"allowsOrderEdit\": \"\",\n \"orderTypeId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"claimTypeId\": \"\",\n \"claimTypeName\": \"\",\n \"solutionTypeId\": \"\",\n \"solutionTypeName\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"employeeLevel\": \"\",\n \"allowsLensChange\": \"\",\n \"allowsRefund\": \"\",\n \"allowsPin\": \"\",\n \"allowsCreditNote\": \"\",\n \"allowsWarranty\": \"\",\n \"allowsOrder\": \"\",\n \"allowsOrderEdit\": \"\",\n \"orderTypeId\": \"\",\n \"orderTypeName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cfc7dec6-3df4-488d-a7fd-6c5361b0e58b", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "solutions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"solutionTypeId\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"employeeLevel\": \"\",\n \"allowsLensChange\": \"\",\n \"allowsRefund\": \"\",\n \"allowsPin\": \"\",\n \"allowsCreditNote\": \"\",\n \"allowsWarranty\": \"\",\n \"allowsOrder\": \"\",\n \"allowsOrderEdit\": \"\",\n \"orderTypeId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4cb92800-ea80-4770-a970-44c4bb062245", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "solutions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"solutionTypeId\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"employeeLevel\": \"\",\n \"allowsLensChange\": \"\",\n \"allowsRefund\": \"\",\n \"allowsPin\": \"\",\n \"allowsCreditNote\": \"\",\n \"allowsWarranty\": \"\",\n \"allowsOrder\": \"\",\n \"allowsOrderEdit\": \"\",\n \"orderTypeId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6a2026de-399d-4981-9043-468c6cf5e4e6", "name": "Authenticated user is missing the `CREAR_RECLAMOTIPORECLAMO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "solutions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"solutionTypeId\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"employeeLevel\": \"\",\n \"allowsLensChange\": \"\",\n \"allowsRefund\": \"\",\n \"allowsPin\": \"\",\n \"allowsCreditNote\": \"\",\n \"allowsWarranty\": \"\",\n \"allowsOrder\": \"\",\n \"allowsOrderEdit\": \"\",\n \"orderTypeId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "59ca46df-8689-438b-82fa-f1e9b861c204", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "solutions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"solutionTypeId\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"employeeLevel\": \"\",\n \"allowsLensChange\": \"\",\n \"allowsRefund\": \"\",\n \"allowsPin\": \"\",\n \"allowsCreditNote\": \"\",\n \"allowsWarranty\": \"\",\n \"allowsOrder\": \"\",\n \"allowsOrderEdit\": \"\",\n \"orderTypeId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "new", "description": "", "item": [ { "id": "081d60cf-0be1-49e9-8270-0733e8f68c79", "name": "Prototype solution for a creation form", "request": { "name": "Prototype solution for a creation form", "description": { "content": "Returns a non-persisted claim solution pre-populated with backend defaults (`enabled=true`, parent claim type company). Optional JSON hints: `claimTypeId` (required), `copyFromId`. The response has no `id`, `version` or audit fields; call `POST /api/v2/solutions` afterwards to persist.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "solutions", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "47ac2491-d754-4764-a5a9-b55ca7db152c", "name": "Solution prototype with defaults", "originalRequest": { "url": { "path": [ "api", "v2", "solutions", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"claimTypeId\": \"\",\n \"claimTypeName\": \"\",\n \"solutionTypeId\": \"\",\n \"solutionTypeName\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"employeeLevel\": \"\",\n \"allowsLensChange\": \"\",\n \"allowsRefund\": \"\",\n \"allowsPin\": \"\",\n \"allowsCreditNote\": \"\",\n \"allowsWarranty\": \"\",\n \"allowsOrder\": \"\",\n \"allowsOrderEdit\": \"\",\n \"orderTypeId\": \"\",\n \"orderTypeName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b4568339-a84b-4f51-9764-1edcd4eec622", "name": "Invalid prepare-create hints", "originalRequest": { "url": { "path": [ "api", "v2", "solutions", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ceec84b9-7a63-4a03-bf49-b2c3e943cac0", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "solutions", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "93b23afa-de41-46ba-a63b-105698c505d3", "name": "Authenticated user is missing the `CREAR_RECLAMOTIPORECLAMO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "solutions", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "949ab2d7-f479-48bc-876a-fdab3dbe160c", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "solutions", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "solution-types", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "392b8a01-6d53-41b2-bcbc-226a891a8b5c", "name": "Get solution type by ID", "request": { "name": "Get solution type by ID", "description": { "content": "Returns a single claim solution type by its primary key.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "solution-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Solution type ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "f67c1944-ccc8-4843-ac2f-82861724232c", "name": "Solution type found", "originalRequest": { "url": { "path": [ "api", "v2", "solution-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Solution type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"warranty\": \"\",\n \"sendEmail\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6a9a1028-b9ac-4170-9a44-b9a6f6190115", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "solution-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Solution type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f4c68674-e4eb-4d9d-a5fd-65fa1cf37aee", "name": "Authenticated user is missing the `VER_RECLAMOTIPOSOLUCION` permission", "originalRequest": { "url": { "path": [ "api", "v2", "solution-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Solution type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6d479ffe-de2c-4018-8905-03a4ac9be821", "name": "Solution type not found", "originalRequest": { "url": { "path": [ "api", "v2", "solution-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Solution type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d0e160d7-eb49-49e0-80bf-8311754ba65d", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "solution-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Solution type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "de3c86a1-1e25-420c-9bd0-8dbd7010327f", "name": "Update solution type", "request": { "name": "Update solution type", "description": { "content": "Full replacement of an existing claim solution type. Send the `If-Match` header for optimistic concurrency (accepted but ignored ÔÇö not versioned).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "solution-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Solution type ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"warranty\": \"\",\n \"sendEmail\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "346f3f11-64f5-4f2e-b05c-09f14e87c26a", "name": "Solution type updated", "originalRequest": { "url": { "path": [ "api", "v2", "solution-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Solution type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"warranty\": \"\",\n \"sendEmail\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"warranty\": \"\",\n \"sendEmail\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "10d90093-c707-4e35-9dc7-50c5d62efc53", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "solution-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Solution type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"warranty\": \"\",\n \"sendEmail\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "dcf4e52e-1d83-49c9-803f-dfbcbf3eb469", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "solution-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Solution type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"warranty\": \"\",\n \"sendEmail\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "39a86c4c-2e45-4cda-a667-c3b3353ee62b", "name": "Authenticated user is missing the `EDITAR_RECLAMOTIPOSOLUCION` permission", "originalRequest": { "url": { "path": [ "api", "v2", "solution-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Solution type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"warranty\": \"\",\n \"sendEmail\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "64a17d67-ec8a-4f5e-80c8-13844d553e90", "name": "Solution type not found", "originalRequest": { "url": { "path": [ "api", "v2", "solution-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Solution type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"warranty\": \"\",\n \"sendEmail\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b55d7d2f-f4a2-4486-b172-354500bcc93e", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "solution-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Solution type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"warranty\": \"\",\n \"sendEmail\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6533f932-741c-4916-a407-39e08cde4449", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "solution-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Solution type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"warranty\": \"\",\n \"sendEmail\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "228da59e-332c-4933-b2f4-09532b1303ae", "name": "Delete solution type", "request": { "name": "Delete solution type", "description": { "content": "Deletes a claim solution type. Send the `If-Match` header with the current ETag (accepted but ignored ÔÇö not versioned).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "solution-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Solution type ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "d421348f-f55b-4da8-93c6-2ed8da6fccee", "name": "Solution type deleted", "originalRequest": { "url": { "path": [ "api", "v2", "solution-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Solution type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4b446eb6-c5e2-48dc-aa7b-4402a8f3f2da", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "solution-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Solution type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b746ed64-0d32-40e9-a5eb-2b58f0d0d454", "name": "Authenticated user is missing the `BORRAR_RECLAMOTIPOSOLUCION` permission", "originalRequest": { "url": { "path": [ "api", "v2", "solution-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Solution type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bff825b9-a0d9-4242-85c1-6928df00d25b", "name": "Solution type not found", "originalRequest": { "url": { "path": [ "api", "v2", "solution-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Solution type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cd3cdad4-f68b-41db-b7af-9b381cb3ddc1", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "solution-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Solution type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "09450a7d-c082-48c2-96d6-31cfadf471d9", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "solution-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Solution type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "565d03c5-27f9-40e4-814d-789b1138900d", "name": "Merge-patch solution type", "request": { "name": "Merge-patch solution type", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "solution-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Solution type ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "143f71f5-b8fd-4ca2-a2bb-24f791264d18", "name": "Solution type patched", "originalRequest": { "url": { "path": [ "api", "v2", "solution-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Solution type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"warranty\": \"\",\n \"sendEmail\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5d3d43ae-9b1a-403e-83bc-470cda56468f", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details. Also returned for malformed merge-patch payloads.", "originalRequest": { "url": { "path": [ "api", "v2", "solution-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Solution type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cecafcf2-ebdb-47d1-b2a7-136bdd7fb093", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "solution-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Solution type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "774a8397-c773-459a-98b3-b24160a8b2c7", "name": "Authenticated user is missing the `EDITAR_RECLAMOTIPOSOLUCION` permission", "originalRequest": { "url": { "path": [ "api", "v2", "solution-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Solution type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "65350932-3569-4c9a-ae88-28ce0ae33047", "name": "Solution type not found", "originalRequest": { "url": { "path": [ "api", "v2", "solution-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Solution type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a297b31d-ced9-40d0-9d68-5dcb9c755845", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "solution-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Solution type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8c8ea0e8-f7d3-42b3-9302-a4e494bd9217", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "solution-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Solution type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "7da36f02-ade0-4573-bb14-0f3a8c849910", "name": "List solution types", "request": { "name": "List solution types", "description": { "content": "Returns a paginated list of claim solution types with envelope `{data, totalCount, skip, limit, hasMore}`. Supports optional RSQL `filter`, `sort` (default `name:asc`), `skip`/`limit` pagination and `modifiedAfter`/`modifiedBefore` bookends.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "solution-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "9fc0eb2c-46bf-4b7a-8268-887bca42a881", "name": "Page of solution types", "originalRequest": { "url": { "path": [ "api", "v2", "solution-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "af3865b1-f39b-418f-9ba0-252ceda910a1", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "solution-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8118472f-b051-42d7-916a-41b96c65eebd", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "solution-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "391430dd-370f-4495-a1d1-36ec47e69959", "name": "Authenticated user is missing the `VER_RECLAMOTIPOSOLUCION` permission", "originalRequest": { "url": { "path": [ "api", "v2", "solution-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3f7598c4-131e-43d3-935a-dfcffe774e04", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "solution-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "852431b2-750e-40e7-91f9-18f90f58b6d5", "name": "Create solution type", "request": { "name": "Create solution type", "description": { "content": "Creates a new claim solution type. Business logic runs in the legacy WAR via the internal commands gateway.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "solution-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"warranty\": \"\",\n \"sendEmail\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "6065c60c-3a57-4d78-a2d9-3d76a494bce1", "name": "Solution type created", "originalRequest": { "url": { "path": [ "api", "v2", "solution-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"warranty\": \"\",\n \"sendEmail\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"warranty\": \"\",\n \"sendEmail\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c6455129-1ce9-4e69-8c63-4aaa858eb81a", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "solution-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"warranty\": \"\",\n \"sendEmail\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "57aeb86f-52c7-48a4-9fc0-636e2de8e13d", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "solution-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"warranty\": \"\",\n \"sendEmail\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "55b6dc72-2d44-46ee-b0d9-eb65b124a612", "name": "Authenticated user is missing the `CREAR_RECLAMOTIPOSOLUCION` permission", "originalRequest": { "url": { "path": [ "api", "v2", "solution-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"warranty\": \"\",\n \"sendEmail\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e2f21861-9e88-43b1-9729-6d53b904cc0e", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "solution-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"warranty\": \"\",\n \"sendEmail\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "new", "description": "", "item": [ { "id": "47d3c6c5-d20b-41f6-adcc-39516dfa718d", "name": "Prototype solution type for a creation form", "request": { "name": "Prototype solution type for a creation form", "description": { "content": "Returns a non-persisted claim solution type pre-populated with backend defaults (`enabled=true`, next `code`, current company). Optional JSON hints: `companyId`, `copyFromId`. The response has no `id`, `version` or audit fields; call `POST /api/v2/solution-types` afterwards to persist.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "solution-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "18efb36a-e14d-4c36-aacb-ba4610d1ffa4", "name": "Solution type prototype with defaults", "originalRequest": { "url": { "path": [ "api", "v2", "solution-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"warranty\": \"\",\n \"sendEmail\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6d1bcba5-2d93-4b98-bd51-a7edbecb32ea", "name": "Invalid prepare-create hints", "originalRequest": { "url": { "path": [ "api", "v2", "solution-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "88c51d66-3fc9-4c1a-a5ba-2ebe8780ec36", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "solution-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6e399ee1-0162-4a27-ae5e-cc5435ca74d1", "name": "Authenticated user is missing the `CREAR_RECLAMOTIPOSOLUCION` permission", "originalRequest": { "url": { "path": [ "api", "v2", "solution-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "16b17b46-b472-4a8f-98ed-fd269a1bbfc6", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "solution-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "series", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "2ce8c469-0cf1-43fb-8385-bc9bc802c9b7", "name": "Get series by ID", "request": { "name": "Get series by ID", "description": { "content": "Returns a single numbering series by its primary key. The response carries a strong `ETag` header (always `\"0\"` ÔÇö Serie is not versioned).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "series", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Series ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "34236853-dadf-4ab0-a4ee-78f011a6d7a2", "name": "Series found", "originalRequest": { "url": { "path": [ "api", "v2", "series", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Series ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"documentKind\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"establishmentCode\": \"\",\n \"emissionPointCode\": \"\",\n \"authorizationCode\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d640d07a-9d7f-4702-a67e-203108337901", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "series", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Series ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1a0c63fd-0658-4a71-b134-f8832a29c3b0", "name": "Authenticated user is missing the `VER_SERIES` permission", "originalRequest": { "url": { "path": [ "api", "v2", "series", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Series ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "363191d8-137c-4a6f-b480-0717306f87e0", "name": "Series not found", "originalRequest": { "url": { "path": [ "api", "v2", "series", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Series ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7f7eece8-ccdf-4ea9-9c23-42b5bb9480f3", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "series", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Series ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "338f927e-1576-4ed1-92d9-a8e62b1a353e", "name": "Update series", "request": { "name": "Update series", "description": { "content": "Full replacement of an existing series. `documentKind` is immutable after create ÔÇö sending a different value returns 400. Send the `If-Match` header for optimistic concurrency (accepted but ignored ÔÇö Serie is not versioned).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "series", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Series ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"documentKind\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"establishmentCode\": \"\",\n \"emissionPointCode\": \"\",\n \"authorizationCode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "fc1696a7-801a-410e-9806-f56c6b2318e2", "name": "Series updated", "originalRequest": { "url": { "path": [ "api", "v2", "series", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Series ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"documentKind\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"establishmentCode\": \"\",\n \"emissionPointCode\": \"\",\n \"authorizationCode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"documentKind\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"establishmentCode\": \"\",\n \"emissionPointCode\": \"\",\n \"authorizationCode\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "694f125e-0022-4e11-a871-3dc615390fad", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "series", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Series ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"documentKind\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"establishmentCode\": \"\",\n \"emissionPointCode\": \"\",\n \"authorizationCode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "38001ca7-9ed6-466e-a182-760a0aad6e1b", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "series", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Series ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"documentKind\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"establishmentCode\": \"\",\n \"emissionPointCode\": \"\",\n \"authorizationCode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "744eb025-3c93-4c7c-823a-aecae76ef636", "name": "Authenticated user is missing the `EDITAR_SERIES` permission", "originalRequest": { "url": { "path": [ "api", "v2", "series", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Series ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"documentKind\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"establishmentCode\": \"\",\n \"emissionPointCode\": \"\",\n \"authorizationCode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f504b490-7b44-4abd-b2b0-0744ec4a9048", "name": "Series not found", "originalRequest": { "url": { "path": [ "api", "v2", "series", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Series ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"documentKind\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"establishmentCode\": \"\",\n \"emissionPointCode\": \"\",\n \"authorizationCode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "77fa3468-7567-4ad3-91a8-2a2af45e7451", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "series", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Series ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"documentKind\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"establishmentCode\": \"\",\n \"emissionPointCode\": \"\",\n \"authorizationCode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "54352253-f235-4195-aaa6-a771b4bec062", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "series", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Series ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"documentKind\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"establishmentCode\": \"\",\n \"emissionPointCode\": \"\",\n \"authorizationCode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "17bdc15a-f6ea-4356-b4bd-1aa1754ce4be", "name": "Delete series", "request": { "name": "Delete series", "description": { "content": "Deletes a numbering series. Send the `If-Match` header with the current ETag (accepted but ignored ÔÇö Serie is not versioned).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "series", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Series ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "74063ef4-7f78-4d54-a40c-dd34fe3083a9", "name": "Series deleted", "originalRequest": { "url": { "path": [ "api", "v2", "series", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Series ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "29aaf50f-e8e1-422d-832e-9a88a4b6aeb7", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "series", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Series ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "42c2853f-6996-42d7-b745-96d7336815b8", "name": "Authenticated user is missing the `BORRAR_SERIES` permission", "originalRequest": { "url": { "path": [ "api", "v2", "series", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Series ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3754377b-ec91-4574-8638-581c3786099c", "name": "Series not found", "originalRequest": { "url": { "path": [ "api", "v2", "series", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Series ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "98947778-51f4-450a-831d-713ef1427ad5", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "series", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Series ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d9869491-fe2a-4dd5-8411-51c7df28d267", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "series", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Series ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "792e565d-d0dd-4ad7-be5d-e7aec60cc786", "name": "Merge-patch series", "request": { "name": "Merge-patch series", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control. `documentKind` cannot be changed via patch.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "series", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Series ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "45139d2f-4c64-4eb1-9212-bc097ee83a56", "name": "Series patched", "originalRequest": { "url": { "path": [ "api", "v2", "series", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Series ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"documentKind\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"establishmentCode\": \"\",\n \"emissionPointCode\": \"\",\n \"authorizationCode\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a40e1337-1fb2-4263-86c5-72eb60d33808", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details. Also returned for malformed merge-patch payloads.", "originalRequest": { "url": { "path": [ "api", "v2", "series", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Series ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6a0cb02e-d0cb-47b5-854b-96803dd91a61", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "series", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Series ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c46cd074-abb1-492a-8363-affbd983d389", "name": "Authenticated user is missing the `EDITAR_SERIES` permission", "originalRequest": { "url": { "path": [ "api", "v2", "series", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Series ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bcff9589-7135-4172-997f-458d6c9fa12c", "name": "Series not found", "originalRequest": { "url": { "path": [ "api", "v2", "series", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Series ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ff6efa0f-4f9a-4c2c-8c4d-b0652844e95e", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "series", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Series ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3986ef91-33d4-47cb-b0f8-5b25577806b6", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "series", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Series ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "818d3f90-3ca8-4f6f-b126-becd8565c067", "name": "List series", "request": { "name": "List series", "description": { "content": "Returns a paginated list of numbering series with envelope `{data, totalCount, skip, limit, hasMore}`. Supports optional RSQL `filter`, `sort` (default `series:asc`), `skip`/`limit` pagination and `modifiedAfter`/`modifiedBefore` bookends. Limit is capped at 200; skip is clamped to >= 0.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "series" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "series:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "b592841e-2b5a-4702-9cf2-c74642a6cd03", "name": "Page of series", "originalRequest": { "url": { "path": [ "api", "v2", "series" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "series:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bbbbd8ed-5fb0-4f71-83bd-b128cb4355d6", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "series" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "series:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b8b737b3-f527-4620-8d23-2efd9d14bfb5", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "series" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "series:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5ab56ef8-654c-4937-95b3-1b5ee7134e09", "name": "Authenticated user is missing the `VER_SERIES` permission", "originalRequest": { "url": { "path": [ "api", "v2", "series" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "series:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "efd98151-a3f8-41f4-adbb-95d286479f03", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "series" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "series:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fa67724c-34da-4e34-90c4-bc82e7d6ae75", "name": "Create series", "request": { "name": "Create series", "description": { "content": "Creates a new numbering series. Business logic runs in the legacy WAR via the internal commands gateway. The combination `series` + `documentKind` + `companyId` must be unique.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "series" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"documentKind\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"establishmentCode\": \"\",\n \"emissionPointCode\": \"\",\n \"authorizationCode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "d7376920-5f08-4075-979e-48ed74d7e458", "name": "Series created", "originalRequest": { "url": { "path": [ "api", "v2", "series" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"documentKind\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"establishmentCode\": \"\",\n \"emissionPointCode\": \"\",\n \"authorizationCode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"documentKind\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"establishmentCode\": \"\",\n \"emissionPointCode\": \"\",\n \"authorizationCode\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6e5818ff-eb0c-490e-a61a-e8e7484dbb2d", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "series" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"documentKind\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"establishmentCode\": \"\",\n \"emissionPointCode\": \"\",\n \"authorizationCode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "716b3e45-fae4-464c-b132-86d845514ff9", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "series" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"documentKind\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"establishmentCode\": \"\",\n \"emissionPointCode\": \"\",\n \"authorizationCode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "945a410b-0135-4bd2-8243-a4d12971ca37", "name": "Authenticated user is missing the `CREAR_SERIES` permission", "originalRequest": { "url": { "path": [ "api", "v2", "series" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"documentKind\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"establishmentCode\": \"\",\n \"emissionPointCode\": \"\",\n \"authorizationCode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "14aa3511-a94a-462f-89f6-8f28fb0127e3", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "series" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"documentKind\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"establishmentCode\": \"\",\n \"emissionPointCode\": \"\",\n \"authorizationCode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "new", "description": "", "item": [ { "id": "5f4f6785-7767-4b59-99b2-ed570c41b9e4", "name": "Prototype series for a creation form", "request": { "name": "Prototype series for a creation form", "description": { "content": "Returns a non-persisted series pre-populated with backend defaults (`enabled=true`, current company). Optional JSON hints: `companyId`, `documentKind` (e.g. FAC-EMI), `copyFromId`. The response has no `id`, `version` or audit fields; call `POST /api/v2/series` afterwards to persist.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "series", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "58a98759-cc75-44de-a1d9-9d16921125f3", "name": "Series prototype with defaults", "originalRequest": { "url": { "path": [ "api", "v2", "series", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"documentKind\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"establishmentCode\": \"\",\n \"emissionPointCode\": \"\",\n \"authorizationCode\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fca29066-7b50-4bbe-8e6e-b4e5e7b00028", "name": "Invalid prepare-create hints", "originalRequest": { "url": { "path": [ "api", "v2", "series", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1c024a43-3f15-42c9-b8ba-f9e81590e610", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "series", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a80bf089-8d41-4078-80eb-f530328cca6d", "name": "Authenticated user is missing the `CREAR_SERIES` permission", "originalRequest": { "url": { "path": [ "api", "v2", "series", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6fe797f1-2a3d-43e9-8fae-1437514d8d3e", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "series", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "scheduling", "description": "", "item": [ { "name": "services", "description": "", "item": [ { "name": "locations", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "54a10f6f-0aaf-4b26-83b9-984e931fd238", "name": "Get service location by ID", "request": { "name": "Get service location by ID", "description": {}, "url": { "path": [ "api", "v2", "scheduling", "services", "locations", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "ee42e72f-b537-4f4d-a12b-2dd68da12d8c", "name": "OK", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "locations", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"address\": \"\",\n \"phone\": \"\",\n \"locationType\": \"ask_booker\",\n \"isActive\": \"\",\n \"isPrivate\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "70741802-58fa-4576-844a-24a2957aa1f4", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "locations", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bf5df78a-44e9-423b-996d-62ba799a2672", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "locations", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fed65fd9-acd2-464f-9c0c-c1cdf5a0f297", "name": "Update service location", "request": { "name": "Update service location", "description": {}, "url": { "path": [ "api", "v2", "scheduling", "services", "locations", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"slug\": \"\",\n \"address\": \"\",\n \"phone\": \"\",\n \"locationType\": \"offline\",\n \"isActive\": \"\",\n \"isPrivate\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "f2b7822a-5b9f-407b-8d95-dbdf899a9a8e", "name": "OK", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "locations", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"slug\": \"\",\n \"address\": \"\",\n \"phone\": \"\",\n \"locationType\": \"offline\",\n \"isActive\": \"\",\n \"isPrivate\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"address\": \"\",\n \"phone\": \"\",\n \"locationType\": \"ask_booker\",\n \"isActive\": \"\",\n \"isPrivate\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "35a2bca3-3f80-4000-ba99-fef85e0efc77", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "locations", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"slug\": \"\",\n \"address\": \"\",\n \"phone\": \"\",\n \"locationType\": \"offline\",\n \"isActive\": \"\",\n \"isPrivate\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3c4f2990-c3f3-46eb-9d14-1588efdfa83f", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "locations", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"slug\": \"\",\n \"address\": \"\",\n \"phone\": \"\",\n \"locationType\": \"offline\",\n \"isActive\": \"\",\n \"isPrivate\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3782910a-6ba9-48bb-92c0-a3e02bc722c3", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "locations", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"slug\": \"\",\n \"address\": \"\",\n \"phone\": \"\",\n \"locationType\": \"offline\",\n \"isActive\": \"\",\n \"isPrivate\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "70dec046-344b-4d23-9d08-69aa1f5f7bee", "name": "Delete service location", "request": { "name": "Delete service location", "description": {}, "url": { "path": [ "api", "v2", "scheduling", "services", "locations", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "aaf4f1cd-8bb6-4949-b716-5ea5c5400d79", "name": "No Content", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "locations", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fd89f8b2-8abe-47ce-b454-cb579b38d83b", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "locations", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4a22bc99-327d-4e54-afc2-0d159183b458", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "locations", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0ecf8790-049a-4084-aa07-907c7f4ff61b", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "locations", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "13ce9733-9352-428c-b324-e4b677f24996", "name": "Merge-patch service location", "request": { "name": "Merge-patch service location", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "scheduling", "services", "locations", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "c8669003-38ef-4b44-b5f9-cd30ee1f2255", "name": "OK", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "locations", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"address\": \"\",\n \"phone\": \"\",\n \"locationType\": \"ask_booker\",\n \"isActive\": \"\",\n \"isPrivate\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "382353dc-49b0-490e-879b-827ca08ae7d5", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "locations", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5d5844d8-81fd-4a5b-9eb5-b395bca2a4a8", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "locations", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a893b4ec-1c22-4d30-aa68-ab159859ec4b", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "locations", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "0094a2f7-cec3-4005-abe3-37a1ea2eecba", "name": "List service locations", "request": { "name": "List service locations", "description": {}, "url": { "path": [ "api", "v2", "scheduling", "services", "locations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "dc4dd938-c19e-4b68-aaa4-3cbf85d95c47", "name": "OK", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "locations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"address\": \"\",\n \"phone\": \"\",\n \"locationType\": \"offline\",\n \"isActive\": \"\",\n \"isPrivate\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n },\n {\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"address\": \"\",\n \"phone\": \"\",\n \"locationType\": \"offline\",\n \"isActive\": \"\",\n \"isPrivate\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5e3f21ee-f19a-418a-8851-423aad64bcb8", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "locations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1ede4da2-a5a2-4d39-83c1-901f831d9570", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "locations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0fbbee54-294a-45f0-a0d4-6f6d7e7b4e1e", "name": "Create service location", "request": { "name": "Create service location", "description": {}, "url": { "path": [ "api", "v2", "scheduling", "services", "locations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"slug\": \"\",\n \"address\": \"\",\n \"phone\": \"\",\n \"locationType\": \"offline\",\n \"isActive\": \"\",\n \"isPrivate\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "e146620f-9220-47d0-b763-0755ce73bfd3", "name": "Created", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "locations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"slug\": \"\",\n \"address\": \"\",\n \"phone\": \"\",\n \"locationType\": \"offline\",\n \"isActive\": \"\",\n \"isPrivate\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"address\": \"\",\n \"phone\": \"\",\n \"locationType\": \"ask_booker\",\n \"isActive\": \"\",\n \"isPrivate\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7ec103b0-db79-4371-8ee8-d6ae35ac2a81", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "locations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"slug\": \"\",\n \"address\": \"\",\n \"phone\": \"\",\n \"locationType\": \"offline\",\n \"isActive\": \"\",\n \"isPrivate\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9b45aac1-d03f-40fa-b4fc-8bedcd185563", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "locations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"slug\": \"\",\n \"address\": \"\",\n \"phone\": \"\",\n \"locationType\": \"offline\",\n \"isActive\": \"\",\n \"isPrivate\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "categories", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "91622650-6dbc-49c9-b630-69c6744415de", "name": "Get service category by ID", "request": { "name": "Get service category by ID", "description": {}, "url": { "path": [ "api", "v2", "scheduling", "services", "categories", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "a74501b4-efa2-4993-a178-9db3ccd169f5", "name": "OK", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "categories", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"sortOrder\": \"\",\n \"isActive\": \"\",\n \"color\": \"RED\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"serviceIds\": [\n \"\",\n \"\"\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "656d64a7-d340-4930-a831-eed419c19d46", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "categories", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "51204416-2cc4-4d08-8661-0d64ab9c6795", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "categories", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8c1640b5-c967-4c2f-9d78-40d5472d5417", "name": "Update service category", "request": { "name": "Update service category", "description": {}, "url": { "path": [ "api", "v2", "scheduling", "services", "categories", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"sortOrder\": \"\",\n \"isActive\": \"\",\n \"color\": \"RED\",\n \"companyId\": \"\",\n \"serviceIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "9d272fcc-ba18-4ecb-a1de-71353ed645e7", "name": "OK", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "categories", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"sortOrder\": \"\",\n \"isActive\": \"\",\n \"color\": \"RED\",\n \"companyId\": \"\",\n \"serviceIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"sortOrder\": \"\",\n \"isActive\": \"\",\n \"color\": \"RED\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"serviceIds\": [\n \"\",\n \"\"\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "acd63339-28fb-4c1b-b667-6c8056161ddd", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "categories", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"sortOrder\": \"\",\n \"isActive\": \"\",\n \"color\": \"RED\",\n \"companyId\": \"\",\n \"serviceIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9f717a6c-9c30-4f2e-9d85-38bef44dd2f9", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "categories", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"sortOrder\": \"\",\n \"isActive\": \"\",\n \"color\": \"RED\",\n \"companyId\": \"\",\n \"serviceIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b1de595c-453c-494f-84d2-d737a6168e5a", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "categories", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"sortOrder\": \"\",\n \"isActive\": \"\",\n \"color\": \"RED\",\n \"companyId\": \"\",\n \"serviceIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e4579fbb-6990-40e0-a676-01527b4788df", "name": "Delete service category", "request": { "name": "Delete service category", "description": {}, "url": { "path": [ "api", "v2", "scheduling", "services", "categories", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "2942b2c9-cb40-41a1-887d-568a20a5ae67", "name": "No Content", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "categories", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "18542ea7-a63c-401a-81ff-d95db1329188", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "categories", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e2a62de4-eefe-47f3-a721-e8ae9ef669df", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "categories", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b58eab46-c37f-48ca-b1fd-eab96955b5e0", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "categories", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "05278172-3b77-41b7-80af-1c2b22c38d18", "name": "Merge-patch service category", "request": { "name": "Merge-patch service category", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "scheduling", "services", "categories", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "d78f74da-10ef-425b-bb9e-ece43e902fdc", "name": "OK", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "categories", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"sortOrder\": \"\",\n \"isActive\": \"\",\n \"color\": \"RED\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"serviceIds\": [\n \"\",\n \"\"\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "892cd3b8-c1db-4773-b41d-03638b25e192", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "categories", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e2d34a8e-423d-4ae7-bfee-377da8c9f1b3", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "categories", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5e66f37e-2542-4e82-b568-3fc0d174ebb6", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "categories", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "c5f48b82-6d0f-4e45-b0c4-fcb25234ed19", "name": "List service categories", "request": { "name": "List service categories", "description": {}, "url": { "path": [ "api", "v2", "scheduling", "services", "categories" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "sortOrder:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "5b1cdf63-c846-41f5-9f80-8c97ab3fedaa", "name": "OK", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "categories" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "sortOrder:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"sortOrder\": \"\",\n \"isActive\": \"\",\n \"color\": \"ORANGE\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"serviceIds\": [\n \"\",\n \"\"\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n },\n {\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"sortOrder\": \"\",\n \"isActive\": \"\",\n \"color\": \"GREEN\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"serviceIds\": [\n \"\",\n \"\"\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c2ecfc57-ce78-4d56-99b0-86de0fe6aded", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "categories" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "sortOrder:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4bdeb3c2-86d8-47e8-917d-a9e257a71415", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "categories" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "sortOrder:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "77d0a991-e4fc-440b-b9b1-d5716318d14a", "name": "Create service category", "request": { "name": "Create service category", "description": {}, "url": { "path": [ "api", "v2", "scheduling", "services", "categories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"sortOrder\": \"\",\n \"isActive\": \"\",\n \"color\": \"RED\",\n \"companyId\": \"\",\n \"serviceIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "d2e2ad1c-1b5a-41a1-a511-e2b388266c54", "name": "Created", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "categories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"sortOrder\": \"\",\n \"isActive\": \"\",\n \"color\": \"RED\",\n \"companyId\": \"\",\n \"serviceIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"sortOrder\": \"\",\n \"isActive\": \"\",\n \"color\": \"RED\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"serviceIds\": [\n \"\",\n \"\"\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b96f0d4e-d16c-4da3-92ad-639100d0007b", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "categories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"sortOrder\": \"\",\n \"isActive\": \"\",\n \"color\": \"RED\",\n \"companyId\": \"\",\n \"serviceIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "02dc01a1-a316-4991-b6a3-faef66909bb8", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "categories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"sortOrder\": \"\",\n \"isActive\": \"\",\n \"color\": \"RED\",\n \"companyId\": \"\",\n \"serviceIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "catalog", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "62755cde-a6cb-43b6-b28f-88aee507aa11", "name": "Get service by ID", "request": { "name": "Get service by ID", "description": {}, "url": { "path": [ "api", "v2", "scheduling", "services", "catalog", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "6790a7ff-92dc-4cd4-8153-6c5fa0225806", "name": "OK", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "catalog", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"serviceCategoryId\": \"\",\n \"serviceCategoryName\": \"\",\n \"staff\": [\n \"\",\n \"\"\n ],\n \"serviceDuration\": \"\",\n \"serviceDurationUnit\": \"mins\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"mins\",\n \"postBuffer\": \"\",\n \"postBufferUnit\": \"hours\",\n \"payment\": {\n \"amount\": \"\",\n \"deposit\": \"\",\n \"depositType\": \"amount\"\n },\n \"eventColor\": \"\",\n \"coverImage\": \"\",\n \"isPrivate\": \"\",\n \"formId\": \"\",\n \"isActive\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"variations\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"serviceDuration\": \"\",\n \"serviceDurationUnit\": \"hours\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"mins\",\n \"postBuffer\": \"\",\n \"postBufferUnit\": \"hours\",\n \"payment\": {\n \"amount\": \"\",\n \"deposit\": \"\",\n \"depositType\": \"amount\"\n },\n \"isActive\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"serviceDuration\": \"\",\n \"serviceDurationUnit\": \"hours\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"hours\",\n \"postBuffer\": \"\",\n \"postBufferUnit\": \"hours\",\n \"payment\": {\n \"amount\": \"\",\n \"deposit\": \"\",\n \"depositType\": \"amount\"\n },\n \"isActive\": \"\"\n }\n ],\n \"addOns\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"duration\": \"\",\n \"durationUnit\": \"hours\",\n \"price\": \"\",\n \"isActive\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"duration\": \"\",\n \"durationUnit\": \"mins\",\n \"price\": \"\",\n \"isActive\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0b29e583-7801-49e3-b5e4-ebff217f9dda", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "catalog", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5f5a9945-ed01-4ae1-8829-5a1c0ed3200b", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "catalog", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d18ed5cf-63fc-47e9-8026-c8fb2218fa6c", "name": "Update service", "request": { "name": "Update service", "description": {}, "url": { "path": [ "api", "v2", "scheduling", "services", "catalog", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"serviceCategoryId\": \"\",\n \"staff\": [\n \"\",\n \"\"\n ],\n \"serviceDuration\": \"\",\n \"serviceDurationUnit\": \"hours\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"hours\",\n \"postBuffer\": \"\",\n \"postBufferUnit\": \"mins\",\n \"payment\": {\n \"amount\": \"\",\n \"deposit\": \"\",\n \"depositType\": \"amount\"\n },\n \"eventColor\": \"\",\n \"coverImage\": \"\",\n \"isPrivate\": \"\",\n \"formId\": \"\",\n \"isActive\": \"\",\n \"companyId\": \"\",\n \"variations\": [\n {\n \"name\": \"\",\n \"slug\": \"\",\n \"serviceDuration\": \"\",\n \"serviceDurationUnit\": \"hours\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"hours\",\n \"postBuffer\": \"\",\n \"postBufferUnit\": \"hours\",\n \"payment\": {\n \"amount\": \"\",\n \"deposit\": \"\",\n \"depositType\": \"percentage\"\n },\n \"isActive\": \"\"\n },\n {\n \"name\": \"\",\n \"slug\": \"\",\n \"serviceDuration\": \"\",\n \"serviceDurationUnit\": \"hours\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"hours\",\n \"postBuffer\": \"\",\n \"postBufferUnit\": \"hours\",\n \"payment\": {\n \"amount\": \"\",\n \"deposit\": \"\",\n \"depositType\": \"amount\"\n },\n \"isActive\": \"\"\n }\n ],\n \"addOns\": [\n {\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"duration\": \"\",\n \"durationUnit\": \"hours\",\n \"price\": \"\",\n \"isActive\": \"\"\n },\n {\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"duration\": \"\",\n \"durationUnit\": \"mins\",\n \"price\": \"\",\n \"isActive\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "86b21bc9-f0f4-46f9-93de-a33cc2c8cef0", "name": "OK", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "catalog", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"serviceCategoryId\": \"\",\n \"staff\": [\n \"\",\n \"\"\n ],\n \"serviceDuration\": \"\",\n \"serviceDurationUnit\": \"hours\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"hours\",\n \"postBuffer\": \"\",\n \"postBufferUnit\": \"mins\",\n \"payment\": {\n \"amount\": \"\",\n \"deposit\": \"\",\n \"depositType\": \"amount\"\n },\n \"eventColor\": \"\",\n \"coverImage\": \"\",\n \"isPrivate\": \"\",\n \"formId\": \"\",\n \"isActive\": \"\",\n \"companyId\": \"\",\n \"variations\": [\n {\n \"name\": \"\",\n \"slug\": \"\",\n \"serviceDuration\": \"\",\n \"serviceDurationUnit\": \"hours\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"hours\",\n \"postBuffer\": \"\",\n \"postBufferUnit\": \"hours\",\n \"payment\": {\n \"amount\": \"\",\n \"deposit\": \"\",\n \"depositType\": \"percentage\"\n },\n \"isActive\": \"\"\n },\n {\n \"name\": \"\",\n \"slug\": \"\",\n \"serviceDuration\": \"\",\n \"serviceDurationUnit\": \"hours\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"hours\",\n \"postBuffer\": \"\",\n \"postBufferUnit\": \"hours\",\n \"payment\": {\n \"amount\": \"\",\n \"deposit\": \"\",\n \"depositType\": \"amount\"\n },\n \"isActive\": \"\"\n }\n ],\n \"addOns\": [\n {\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"duration\": \"\",\n \"durationUnit\": \"hours\",\n \"price\": \"\",\n \"isActive\": \"\"\n },\n {\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"duration\": \"\",\n \"durationUnit\": \"mins\",\n \"price\": \"\",\n \"isActive\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"serviceCategoryId\": \"\",\n \"serviceCategoryName\": \"\",\n \"staff\": [\n \"\",\n \"\"\n ],\n \"serviceDuration\": \"\",\n \"serviceDurationUnit\": \"mins\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"mins\",\n \"postBuffer\": \"\",\n \"postBufferUnit\": \"hours\",\n \"payment\": {\n \"amount\": \"\",\n \"deposit\": \"\",\n \"depositType\": \"amount\"\n },\n \"eventColor\": \"\",\n \"coverImage\": \"\",\n \"isPrivate\": \"\",\n \"formId\": \"\",\n \"isActive\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"variations\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"serviceDuration\": \"\",\n \"serviceDurationUnit\": \"hours\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"mins\",\n \"postBuffer\": \"\",\n \"postBufferUnit\": \"hours\",\n \"payment\": {\n \"amount\": \"\",\n \"deposit\": \"\",\n \"depositType\": \"amount\"\n },\n \"isActive\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"serviceDuration\": \"\",\n \"serviceDurationUnit\": \"hours\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"hours\",\n \"postBuffer\": \"\",\n \"postBufferUnit\": \"hours\",\n \"payment\": {\n \"amount\": \"\",\n \"deposit\": \"\",\n \"depositType\": \"amount\"\n },\n \"isActive\": \"\"\n }\n ],\n \"addOns\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"duration\": \"\",\n \"durationUnit\": \"hours\",\n \"price\": \"\",\n \"isActive\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"duration\": \"\",\n \"durationUnit\": \"mins\",\n \"price\": \"\",\n \"isActive\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fe3200ec-12fd-4eb3-ac06-6b115cd45e69", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "catalog", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"serviceCategoryId\": \"\",\n \"staff\": [\n \"\",\n \"\"\n ],\n \"serviceDuration\": \"\",\n \"serviceDurationUnit\": \"hours\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"hours\",\n \"postBuffer\": \"\",\n \"postBufferUnit\": \"mins\",\n \"payment\": {\n \"amount\": \"\",\n \"deposit\": \"\",\n \"depositType\": \"amount\"\n },\n \"eventColor\": \"\",\n \"coverImage\": \"\",\n \"isPrivate\": \"\",\n \"formId\": \"\",\n \"isActive\": \"\",\n \"companyId\": \"\",\n \"variations\": [\n {\n \"name\": \"\",\n \"slug\": \"\",\n \"serviceDuration\": \"\",\n \"serviceDurationUnit\": \"hours\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"hours\",\n \"postBuffer\": \"\",\n \"postBufferUnit\": \"hours\",\n \"payment\": {\n \"amount\": \"\",\n \"deposit\": \"\",\n \"depositType\": \"percentage\"\n },\n \"isActive\": \"\"\n },\n {\n \"name\": \"\",\n \"slug\": \"\",\n \"serviceDuration\": \"\",\n \"serviceDurationUnit\": \"hours\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"hours\",\n \"postBuffer\": \"\",\n \"postBufferUnit\": \"hours\",\n \"payment\": {\n \"amount\": \"\",\n \"deposit\": \"\",\n \"depositType\": \"amount\"\n },\n \"isActive\": \"\"\n }\n ],\n \"addOns\": [\n {\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"duration\": \"\",\n \"durationUnit\": \"hours\",\n \"price\": \"\",\n \"isActive\": \"\"\n },\n {\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"duration\": \"\",\n \"durationUnit\": \"mins\",\n \"price\": \"\",\n \"isActive\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f57c8815-53d1-430e-9dfe-651e7bb55602", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "catalog", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"serviceCategoryId\": \"\",\n \"staff\": [\n \"\",\n \"\"\n ],\n \"serviceDuration\": \"\",\n \"serviceDurationUnit\": \"hours\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"hours\",\n \"postBuffer\": \"\",\n \"postBufferUnit\": \"mins\",\n \"payment\": {\n \"amount\": \"\",\n \"deposit\": \"\",\n \"depositType\": \"amount\"\n },\n \"eventColor\": \"\",\n \"coverImage\": \"\",\n \"isPrivate\": \"\",\n \"formId\": \"\",\n \"isActive\": \"\",\n \"companyId\": \"\",\n \"variations\": [\n {\n \"name\": \"\",\n \"slug\": \"\",\n \"serviceDuration\": \"\",\n \"serviceDurationUnit\": \"hours\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"hours\",\n \"postBuffer\": \"\",\n \"postBufferUnit\": \"hours\",\n \"payment\": {\n \"amount\": \"\",\n \"deposit\": \"\",\n \"depositType\": \"percentage\"\n },\n \"isActive\": \"\"\n },\n {\n \"name\": \"\",\n \"slug\": \"\",\n \"serviceDuration\": \"\",\n \"serviceDurationUnit\": \"hours\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"hours\",\n \"postBuffer\": \"\",\n \"postBufferUnit\": \"hours\",\n \"payment\": {\n \"amount\": \"\",\n \"deposit\": \"\",\n \"depositType\": \"amount\"\n },\n \"isActive\": \"\"\n }\n ],\n \"addOns\": [\n {\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"duration\": \"\",\n \"durationUnit\": \"hours\",\n \"price\": \"\",\n \"isActive\": \"\"\n },\n {\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"duration\": \"\",\n \"durationUnit\": \"mins\",\n \"price\": \"\",\n \"isActive\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e5704a31-ce66-4025-bfbd-1a678b450fcc", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "catalog", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"serviceCategoryId\": \"\",\n \"staff\": [\n \"\",\n \"\"\n ],\n \"serviceDuration\": \"\",\n \"serviceDurationUnit\": \"hours\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"hours\",\n \"postBuffer\": \"\",\n \"postBufferUnit\": \"mins\",\n \"payment\": {\n \"amount\": \"\",\n \"deposit\": \"\",\n \"depositType\": \"amount\"\n },\n \"eventColor\": \"\",\n \"coverImage\": \"\",\n \"isPrivate\": \"\",\n \"formId\": \"\",\n \"isActive\": \"\",\n \"companyId\": \"\",\n \"variations\": [\n {\n \"name\": \"\",\n \"slug\": \"\",\n \"serviceDuration\": \"\",\n \"serviceDurationUnit\": \"hours\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"hours\",\n \"postBuffer\": \"\",\n \"postBufferUnit\": \"hours\",\n \"payment\": {\n \"amount\": \"\",\n \"deposit\": \"\",\n \"depositType\": \"percentage\"\n },\n \"isActive\": \"\"\n },\n {\n \"name\": \"\",\n \"slug\": \"\",\n \"serviceDuration\": \"\",\n \"serviceDurationUnit\": \"hours\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"hours\",\n \"postBuffer\": \"\",\n \"postBufferUnit\": \"hours\",\n \"payment\": {\n \"amount\": \"\",\n \"deposit\": \"\",\n \"depositType\": \"amount\"\n },\n \"isActive\": \"\"\n }\n ],\n \"addOns\": [\n {\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"duration\": \"\",\n \"durationUnit\": \"hours\",\n \"price\": \"\",\n \"isActive\": \"\"\n },\n {\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"duration\": \"\",\n \"durationUnit\": \"mins\",\n \"price\": \"\",\n \"isActive\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4475dbe1-c75e-4da9-bf7b-4fb32725b201", "name": "Delete service", "request": { "name": "Delete service", "description": {}, "url": { "path": [ "api", "v2", "scheduling", "services", "catalog", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "5a507e65-9ef1-482e-a54a-2deb7a90a006", "name": "No Content", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "catalog", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cfabfd32-94b9-4119-8520-4ddc8f9b003e", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "catalog", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6c8dc7e1-a403-46b6-9c95-7d990e828498", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "catalog", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d753b7c9-838f-48b7-9ef4-9f651e1551e7", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "catalog", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ae58141e-99ba-43f0-8e16-726ce447a421", "name": "Merge-patch service", "request": { "name": "Merge-patch service", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "scheduling", "services", "catalog", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "53dfae7c-3dae-42a2-8c80-ef2691e0f3d6", "name": "OK", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "catalog", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"serviceCategoryId\": \"\",\n \"serviceCategoryName\": \"\",\n \"staff\": [\n \"\",\n \"\"\n ],\n \"serviceDuration\": \"\",\n \"serviceDurationUnit\": \"mins\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"mins\",\n \"postBuffer\": \"\",\n \"postBufferUnit\": \"hours\",\n \"payment\": {\n \"amount\": \"\",\n \"deposit\": \"\",\n \"depositType\": \"amount\"\n },\n \"eventColor\": \"\",\n \"coverImage\": \"\",\n \"isPrivate\": \"\",\n \"formId\": \"\",\n \"isActive\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"variations\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"serviceDuration\": \"\",\n \"serviceDurationUnit\": \"hours\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"mins\",\n \"postBuffer\": \"\",\n \"postBufferUnit\": \"hours\",\n \"payment\": {\n \"amount\": \"\",\n \"deposit\": \"\",\n \"depositType\": \"amount\"\n },\n \"isActive\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"serviceDuration\": \"\",\n \"serviceDurationUnit\": \"hours\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"hours\",\n \"postBuffer\": \"\",\n \"postBufferUnit\": \"hours\",\n \"payment\": {\n \"amount\": \"\",\n \"deposit\": \"\",\n \"depositType\": \"amount\"\n },\n \"isActive\": \"\"\n }\n ],\n \"addOns\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"duration\": \"\",\n \"durationUnit\": \"hours\",\n \"price\": \"\",\n \"isActive\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"duration\": \"\",\n \"durationUnit\": \"mins\",\n \"price\": \"\",\n \"isActive\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "df35b509-9227-43eb-825a-2d7f95042384", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "catalog", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e88165a5-95cb-47f0-8536-1df108536acb", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "catalog", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "18bb5ffd-6b6e-4861-8b6a-cf95766ea478", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "catalog", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "6397f778-b454-42a0-86db-f428ce5936e0", "name": "List service catalog", "request": { "name": "List service catalog", "description": {}, "url": { "path": [ "api", "v2", "scheduling", "services", "catalog" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "bd989896-6837-48de-a1ec-fe6e7c2a41ef", "name": "OK", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "catalog" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"serviceCategoryId\": \"\",\n \"serviceCategoryName\": \"\",\n \"staff\": [\n \"\",\n \"\"\n ],\n \"serviceDuration\": \"\",\n \"serviceDurationUnit\": \"mins\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"mins\",\n \"postBuffer\": \"\",\n \"postBufferUnit\": \"hours\",\n \"payment\": {\n \"amount\": \"\",\n \"deposit\": \"\",\n \"depositType\": \"amount\"\n },\n \"eventColor\": \"\",\n \"coverImage\": \"\",\n \"isPrivate\": \"\",\n \"formId\": \"\",\n \"isActive\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"variations\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"serviceDuration\": \"\",\n \"serviceDurationUnit\": \"mins\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"hours\",\n \"postBuffer\": \"\",\n \"postBufferUnit\": \"hours\",\n \"payment\": {\n \"amount\": \"\",\n \"deposit\": \"\",\n \"depositType\": \"percentage\"\n },\n \"isActive\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"serviceDuration\": \"\",\n \"serviceDurationUnit\": \"mins\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"mins\",\n \"postBuffer\": \"\",\n \"postBufferUnit\": \"mins\",\n \"payment\": {\n \"amount\": \"\",\n \"deposit\": \"\",\n \"depositType\": \"percentage\"\n },\n \"isActive\": \"\"\n }\n ],\n \"addOns\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"duration\": \"\",\n \"durationUnit\": \"mins\",\n \"price\": \"\",\n \"isActive\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"duration\": \"\",\n \"durationUnit\": \"hours\",\n \"price\": \"\",\n \"isActive\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n },\n {\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"serviceCategoryId\": \"\",\n \"serviceCategoryName\": \"\",\n \"staff\": [\n \"\",\n \"\"\n ],\n \"serviceDuration\": \"\",\n \"serviceDurationUnit\": \"mins\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"mins\",\n \"postBuffer\": \"\",\n \"postBufferUnit\": \"hours\",\n \"payment\": {\n \"amount\": \"\",\n \"deposit\": \"\",\n \"depositType\": \"percentage\"\n },\n \"eventColor\": \"\",\n \"coverImage\": \"\",\n \"isPrivate\": \"\",\n \"formId\": \"\",\n \"isActive\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"variations\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"serviceDuration\": \"\",\n \"serviceDurationUnit\": \"mins\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"hours\",\n \"postBuffer\": \"\",\n \"postBufferUnit\": \"hours\",\n \"payment\": {\n \"amount\": \"\",\n \"deposit\": \"\",\n \"depositType\": \"amount\"\n },\n \"isActive\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"serviceDuration\": \"\",\n \"serviceDurationUnit\": \"hours\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"mins\",\n \"postBuffer\": \"\",\n \"postBufferUnit\": \"mins\",\n \"payment\": {\n \"amount\": \"\",\n \"deposit\": \"\",\n \"depositType\": \"amount\"\n },\n \"isActive\": \"\"\n }\n ],\n \"addOns\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"duration\": \"\",\n \"durationUnit\": \"hours\",\n \"price\": \"\",\n \"isActive\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"duration\": \"\",\n \"durationUnit\": \"hours\",\n \"price\": \"\",\n \"isActive\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8ea36a04-6a0f-4ccb-8c1d-2f7ca3b66b5b", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "catalog" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "83c63995-943b-4af7-845c-30848cb1e049", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "catalog" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "018f2d5c-bdfb-4191-a45d-12e3f4aed020", "name": "Create service", "request": { "name": "Create service", "description": {}, "url": { "path": [ "api", "v2", "scheduling", "services", "catalog" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"serviceCategoryId\": \"\",\n \"staff\": [\n \"\",\n \"\"\n ],\n \"serviceDuration\": \"\",\n \"serviceDurationUnit\": \"hours\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"hours\",\n \"postBuffer\": \"\",\n \"postBufferUnit\": \"mins\",\n \"payment\": {\n \"amount\": \"\",\n \"deposit\": \"\",\n \"depositType\": \"amount\"\n },\n \"eventColor\": \"\",\n \"coverImage\": \"\",\n \"isPrivate\": \"\",\n \"formId\": \"\",\n \"isActive\": \"\",\n \"companyId\": \"\",\n \"variations\": [\n {\n \"name\": \"\",\n \"slug\": \"\",\n \"serviceDuration\": \"\",\n \"serviceDurationUnit\": \"hours\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"hours\",\n \"postBuffer\": \"\",\n \"postBufferUnit\": \"hours\",\n \"payment\": {\n \"amount\": \"\",\n \"deposit\": \"\",\n \"depositType\": \"percentage\"\n },\n \"isActive\": \"\"\n },\n {\n \"name\": \"\",\n \"slug\": \"\",\n \"serviceDuration\": \"\",\n \"serviceDurationUnit\": \"hours\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"hours\",\n \"postBuffer\": \"\",\n \"postBufferUnit\": \"hours\",\n \"payment\": {\n \"amount\": \"\",\n \"deposit\": \"\",\n \"depositType\": \"amount\"\n },\n \"isActive\": \"\"\n }\n ],\n \"addOns\": [\n {\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"duration\": \"\",\n \"durationUnit\": \"hours\",\n \"price\": \"\",\n \"isActive\": \"\"\n },\n {\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"duration\": \"\",\n \"durationUnit\": \"mins\",\n \"price\": \"\",\n \"isActive\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "ea7ad44a-956a-4eb7-ad8a-b81b4f976ff7", "name": "Created", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "catalog" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"serviceCategoryId\": \"\",\n \"staff\": [\n \"\",\n \"\"\n ],\n \"serviceDuration\": \"\",\n \"serviceDurationUnit\": \"hours\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"hours\",\n \"postBuffer\": \"\",\n \"postBufferUnit\": \"mins\",\n \"payment\": {\n \"amount\": \"\",\n \"deposit\": \"\",\n \"depositType\": \"amount\"\n },\n \"eventColor\": \"\",\n \"coverImage\": \"\",\n \"isPrivate\": \"\",\n \"formId\": \"\",\n \"isActive\": \"\",\n \"companyId\": \"\",\n \"variations\": [\n {\n \"name\": \"\",\n \"slug\": \"\",\n \"serviceDuration\": \"\",\n \"serviceDurationUnit\": \"hours\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"hours\",\n \"postBuffer\": \"\",\n \"postBufferUnit\": \"hours\",\n \"payment\": {\n \"amount\": \"\",\n \"deposit\": \"\",\n \"depositType\": \"percentage\"\n },\n \"isActive\": \"\"\n },\n {\n \"name\": \"\",\n \"slug\": \"\",\n \"serviceDuration\": \"\",\n \"serviceDurationUnit\": \"hours\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"hours\",\n \"postBuffer\": \"\",\n \"postBufferUnit\": \"hours\",\n \"payment\": {\n \"amount\": \"\",\n \"deposit\": \"\",\n \"depositType\": \"amount\"\n },\n \"isActive\": \"\"\n }\n ],\n \"addOns\": [\n {\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"duration\": \"\",\n \"durationUnit\": \"hours\",\n \"price\": \"\",\n \"isActive\": \"\"\n },\n {\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"duration\": \"\",\n \"durationUnit\": \"mins\",\n \"price\": \"\",\n \"isActive\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"serviceCategoryId\": \"\",\n \"serviceCategoryName\": \"\",\n \"staff\": [\n \"\",\n \"\"\n ],\n \"serviceDuration\": \"\",\n \"serviceDurationUnit\": \"mins\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"mins\",\n \"postBuffer\": \"\",\n \"postBufferUnit\": \"hours\",\n \"payment\": {\n \"amount\": \"\",\n \"deposit\": \"\",\n \"depositType\": \"amount\"\n },\n \"eventColor\": \"\",\n \"coverImage\": \"\",\n \"isPrivate\": \"\",\n \"formId\": \"\",\n \"isActive\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"variations\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"serviceDuration\": \"\",\n \"serviceDurationUnit\": \"hours\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"mins\",\n \"postBuffer\": \"\",\n \"postBufferUnit\": \"hours\",\n \"payment\": {\n \"amount\": \"\",\n \"deposit\": \"\",\n \"depositType\": \"amount\"\n },\n \"isActive\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"serviceDuration\": \"\",\n \"serviceDurationUnit\": \"hours\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"hours\",\n \"postBuffer\": \"\",\n \"postBufferUnit\": \"hours\",\n \"payment\": {\n \"amount\": \"\",\n \"deposit\": \"\",\n \"depositType\": \"amount\"\n },\n \"isActive\": \"\"\n }\n ],\n \"addOns\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"duration\": \"\",\n \"durationUnit\": \"hours\",\n \"price\": \"\",\n \"isActive\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"duration\": \"\",\n \"durationUnit\": \"mins\",\n \"price\": \"\",\n \"isActive\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d7e92a71-6305-43ab-a5b8-6ee3287173d5", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "catalog" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"serviceCategoryId\": \"\",\n \"staff\": [\n \"\",\n \"\"\n ],\n \"serviceDuration\": \"\",\n \"serviceDurationUnit\": \"hours\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"hours\",\n \"postBuffer\": \"\",\n \"postBufferUnit\": \"mins\",\n \"payment\": {\n \"amount\": \"\",\n \"deposit\": \"\",\n \"depositType\": \"amount\"\n },\n \"eventColor\": \"\",\n \"coverImage\": \"\",\n \"isPrivate\": \"\",\n \"formId\": \"\",\n \"isActive\": \"\",\n \"companyId\": \"\",\n \"variations\": [\n {\n \"name\": \"\",\n \"slug\": \"\",\n \"serviceDuration\": \"\",\n \"serviceDurationUnit\": \"hours\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"hours\",\n \"postBuffer\": \"\",\n \"postBufferUnit\": \"hours\",\n \"payment\": {\n \"amount\": \"\",\n \"deposit\": \"\",\n \"depositType\": \"percentage\"\n },\n \"isActive\": \"\"\n },\n {\n \"name\": \"\",\n \"slug\": \"\",\n \"serviceDuration\": \"\",\n \"serviceDurationUnit\": \"hours\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"hours\",\n \"postBuffer\": \"\",\n \"postBufferUnit\": \"hours\",\n \"payment\": {\n \"amount\": \"\",\n \"deposit\": \"\",\n \"depositType\": \"amount\"\n },\n \"isActive\": \"\"\n }\n ],\n \"addOns\": [\n {\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"duration\": \"\",\n \"durationUnit\": \"hours\",\n \"price\": \"\",\n \"isActive\": \"\"\n },\n {\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"duration\": \"\",\n \"durationUnit\": \"mins\",\n \"price\": \"\",\n \"isActive\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0c8ecf6a-7b55-421a-811d-1b288966a2a1", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "catalog" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"serviceCategoryId\": \"\",\n \"staff\": [\n \"\",\n \"\"\n ],\n \"serviceDuration\": \"\",\n \"serviceDurationUnit\": \"hours\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"hours\",\n \"postBuffer\": \"\",\n \"postBufferUnit\": \"mins\",\n \"payment\": {\n \"amount\": \"\",\n \"deposit\": \"\",\n \"depositType\": \"amount\"\n },\n \"eventColor\": \"\",\n \"coverImage\": \"\",\n \"isPrivate\": \"\",\n \"formId\": \"\",\n \"isActive\": \"\",\n \"companyId\": \"\",\n \"variations\": [\n {\n \"name\": \"\",\n \"slug\": \"\",\n \"serviceDuration\": \"\",\n \"serviceDurationUnit\": \"hours\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"hours\",\n \"postBuffer\": \"\",\n \"postBufferUnit\": \"hours\",\n \"payment\": {\n \"amount\": \"\",\n \"deposit\": \"\",\n \"depositType\": \"percentage\"\n },\n \"isActive\": \"\"\n },\n {\n \"name\": \"\",\n \"slug\": \"\",\n \"serviceDuration\": \"\",\n \"serviceDurationUnit\": \"hours\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"hours\",\n \"postBuffer\": \"\",\n \"postBufferUnit\": \"hours\",\n \"payment\": {\n \"amount\": \"\",\n \"deposit\": \"\",\n \"depositType\": \"amount\"\n },\n \"isActive\": \"\"\n }\n ],\n \"addOns\": [\n {\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"duration\": \"\",\n \"durationUnit\": \"hours\",\n \"price\": \"\",\n \"isActive\": \"\"\n },\n {\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"duration\": \"\",\n \"durationUnit\": \"mins\",\n \"price\": \"\",\n \"isActive\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "bookings", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "583f8f77-5ce3-4a69-a3c9-477d372d68be", "name": "Get service booking by ID", "request": { "name": "Get service booking by ID", "description": {}, "url": { "path": [ "api", "v2", "scheduling", "services", "bookings", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "130df004-2415-4f29-8110-35a731abe22a", "name": "OK", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "bookings", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"contactId\": \"\",\n \"contactName\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"timezone\": \"\",\n \"serviceLocationId\": \"\",\n \"serviceLocationName\": \"\",\n \"meetingLocation\": \"\",\n \"calendarId\": \"\",\n \"title\": \"\",\n \"notes\": \"\",\n \"services\": [\n {\n \"lineId\": \"\",\n \"staffId\": \"\",\n \"position\": \"\",\n \"addOns\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n }\n ],\n \"id\": \"\"\n },\n {\n \"lineId\": \"\",\n \"staffId\": \"\",\n \"position\": \"\",\n \"addOns\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n }\n ],\n \"id\": \"\"\n }\n ],\n \"companyId\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d4cd8cdd-05b0-40bb-b3e1-0fdf192af987", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "bookings", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ac3312fa-de8b-4d0a-8355-95949a650f6d", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "bookings", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "569bb8f1-de12-4082-a444-c6cf112898f2", "name": "Update service booking", "request": { "name": "Update service booking", "description": {}, "url": { "path": [ "api", "v2", "scheduling", "services", "bookings", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "overrideAvailability", "value": "false" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "skipSchedulingNotice", "value": "false" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"contactId\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"timezone\": \"\",\n \"serviceLocationId\": \"\",\n \"meetingLocation\": \"\",\n \"calendarId\": \"\",\n \"title\": \"\",\n \"notes\": \"\",\n \"services\": [\n {\n \"staffId\": \"\",\n \"position\": \"\",\n \"addOns\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n }\n ],\n \"id\": \"\"\n },\n {\n \"staffId\": \"\",\n \"position\": \"\",\n \"addOns\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n }\n ],\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "17aa041d-c9b3-4a1a-aa32-c699487bbe1f", "name": "OK", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "bookings", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "overrideAvailability", "value": "false" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "skipSchedulingNotice", "value": "false" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"contactId\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"timezone\": \"\",\n \"serviceLocationId\": \"\",\n \"meetingLocation\": \"\",\n \"calendarId\": \"\",\n \"title\": \"\",\n \"notes\": \"\",\n \"services\": [\n {\n \"staffId\": \"\",\n \"position\": \"\",\n \"addOns\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n }\n ],\n \"id\": \"\"\n },\n {\n \"staffId\": \"\",\n \"position\": \"\",\n \"addOns\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n }\n ],\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"contactId\": \"\",\n \"contactName\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"timezone\": \"\",\n \"serviceLocationId\": \"\",\n \"serviceLocationName\": \"\",\n \"meetingLocation\": \"\",\n \"calendarId\": \"\",\n \"title\": \"\",\n \"notes\": \"\",\n \"services\": [\n {\n \"lineId\": \"\",\n \"staffId\": \"\",\n \"position\": \"\",\n \"addOns\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n }\n ],\n \"id\": \"\"\n },\n {\n \"lineId\": \"\",\n \"staffId\": \"\",\n \"position\": \"\",\n \"addOns\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n }\n ],\n \"id\": \"\"\n }\n ],\n \"companyId\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3a556ea8-25ec-4e96-8b7c-6a550bfaf1da", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "bookings", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "overrideAvailability", "value": "false" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "skipSchedulingNotice", "value": "false" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"contactId\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"timezone\": \"\",\n \"serviceLocationId\": \"\",\n \"meetingLocation\": \"\",\n \"calendarId\": \"\",\n \"title\": \"\",\n \"notes\": \"\",\n \"services\": [\n {\n \"staffId\": \"\",\n \"position\": \"\",\n \"addOns\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n }\n ],\n \"id\": \"\"\n },\n {\n \"staffId\": \"\",\n \"position\": \"\",\n \"addOns\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n }\n ],\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9a915281-1fb5-4ef3-b801-cc21ef7e0fe8", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "bookings", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "overrideAvailability", "value": "false" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "skipSchedulingNotice", "value": "false" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"contactId\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"timezone\": \"\",\n \"serviceLocationId\": \"\",\n \"meetingLocation\": \"\",\n \"calendarId\": \"\",\n \"title\": \"\",\n \"notes\": \"\",\n \"services\": [\n {\n \"staffId\": \"\",\n \"position\": \"\",\n \"addOns\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n }\n ],\n \"id\": \"\"\n },\n {\n \"staffId\": \"\",\n \"position\": \"\",\n \"addOns\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n }\n ],\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "23fa1c97-f791-4d20-b924-52a387931683", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "bookings", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "overrideAvailability", "value": "false" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "skipSchedulingNotice", "value": "false" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"contactId\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"timezone\": \"\",\n \"serviceLocationId\": \"\",\n \"meetingLocation\": \"\",\n \"calendarId\": \"\",\n \"title\": \"\",\n \"notes\": \"\",\n \"services\": [\n {\n \"staffId\": \"\",\n \"position\": \"\",\n \"addOns\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n }\n ],\n \"id\": \"\"\n },\n {\n \"staffId\": \"\",\n \"position\": \"\",\n \"addOns\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n }\n ],\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ee0abde3-fe08-497a-859b-e5f60501c38c", "name": "Delete service booking", "request": { "name": "Delete service booking", "description": {}, "url": { "path": [ "api", "v2", "scheduling", "services", "bookings", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "ed83d285-1d2a-44c5-85d8-7822c0374f76", "name": "No Content", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "bookings", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "eb32e9fa-6be1-4c9f-9c10-13d56922fde0", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "bookings", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7b83b4f6-9727-4206-a586-6c1670370bc2", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "bookings", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fb8e3056-7446-4066-a00d-e91ae334eb03", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "bookings", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b4797920-31ec-4127-84cd-c1faad781ed8", "name": "Merge-patch service booking", "request": { "name": "Merge-patch service booking", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "scheduling", "services", "bookings", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "7c29306b-26be-4863-a62e-0cad1b879d41", "name": "OK", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "bookings", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"contactId\": \"\",\n \"contactName\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"timezone\": \"\",\n \"serviceLocationId\": \"\",\n \"serviceLocationName\": \"\",\n \"meetingLocation\": \"\",\n \"calendarId\": \"\",\n \"title\": \"\",\n \"notes\": \"\",\n \"services\": [\n {\n \"lineId\": \"\",\n \"staffId\": \"\",\n \"position\": \"\",\n \"addOns\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n }\n ],\n \"id\": \"\"\n },\n {\n \"lineId\": \"\",\n \"staffId\": \"\",\n \"position\": \"\",\n \"addOns\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n }\n ],\n \"id\": \"\"\n }\n ],\n \"companyId\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bd09e600-fbd4-403e-b516-5a70259768c9", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "bookings", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "11d71df9-a23b-4011-870e-f615a4e78c12", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "bookings", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5575ca6f-5c7b-4e6c-b6c4-e765351fa503", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "bookings", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "556fab62-c135-432e-a805-1e34d57df898", "name": "List service bookings", "request": { "name": "List service bookings", "description": {}, "url": { "path": [ "api", "v2", "scheduling", "services", "bookings" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "startTime:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "90fa2e1b-0147-48f1-b6cd-f334d6d0071b", "name": "OK", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "bookings" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "startTime:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"version\": \"\",\n \"contactId\": \"\",\n \"contactName\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"timezone\": \"\",\n \"serviceLocationId\": \"\",\n \"serviceLocationName\": \"\",\n \"meetingLocation\": \"\",\n \"calendarId\": \"\",\n \"title\": \"\",\n \"notes\": \"\",\n \"services\": [\n {\n \"lineId\": \"\",\n \"staffId\": \"\",\n \"position\": \"\",\n \"addOns\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n }\n ],\n \"id\": \"\"\n },\n {\n \"lineId\": \"\",\n \"staffId\": \"\",\n \"position\": \"\",\n \"addOns\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n }\n ],\n \"id\": \"\"\n }\n ],\n \"companyId\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n },\n {\n \"id\": \"\",\n \"version\": \"\",\n \"contactId\": \"\",\n \"contactName\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"timezone\": \"\",\n \"serviceLocationId\": \"\",\n \"serviceLocationName\": \"\",\n \"meetingLocation\": \"\",\n \"calendarId\": \"\",\n \"title\": \"\",\n \"notes\": \"\",\n \"services\": [\n {\n \"lineId\": \"\",\n \"staffId\": \"\",\n \"position\": \"\",\n \"addOns\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n }\n ],\n \"id\": \"\"\n },\n {\n \"lineId\": \"\",\n \"staffId\": \"\",\n \"position\": \"\",\n \"addOns\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n }\n ],\n \"id\": \"\"\n }\n ],\n \"companyId\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4feb6479-f1d6-4fd6-9c0e-9daadcab9446", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "bookings" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "startTime:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3c44ceff-56e4-464a-8eae-e5d5f6ba63cc", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "bookings" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "startTime:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "98659b98-7df5-448d-95f5-32cb14ad8c34", "name": "Create service booking", "request": { "name": "Create service booking", "description": {}, "url": { "path": [ "api", "v2", "scheduling", "services", "bookings" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "overrideAvailability", "value": "false" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "skipSchedulingNotice", "value": "false" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contactId\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"timezone\": \"\",\n \"serviceLocationId\": \"\",\n \"meetingLocation\": \"\",\n \"calendarId\": \"\",\n \"title\": \"\",\n \"notes\": \"\",\n \"services\": [\n {\n \"staffId\": \"\",\n \"position\": \"\",\n \"addOns\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n }\n ],\n \"id\": \"\"\n },\n {\n \"staffId\": \"\",\n \"position\": \"\",\n \"addOns\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n }\n ],\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "002cdf6a-8b31-4e6a-bd2b-d9771470578b", "name": "Created", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "bookings" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "overrideAvailability", "value": "false" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "skipSchedulingNotice", "value": "false" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contactId\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"timezone\": \"\",\n \"serviceLocationId\": \"\",\n \"meetingLocation\": \"\",\n \"calendarId\": \"\",\n \"title\": \"\",\n \"notes\": \"\",\n \"services\": [\n {\n \"staffId\": \"\",\n \"position\": \"\",\n \"addOns\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n }\n ],\n \"id\": \"\"\n },\n {\n \"staffId\": \"\",\n \"position\": \"\",\n \"addOns\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n }\n ],\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"contactId\": \"\",\n \"contactName\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"timezone\": \"\",\n \"serviceLocationId\": \"\",\n \"serviceLocationName\": \"\",\n \"meetingLocation\": \"\",\n \"calendarId\": \"\",\n \"title\": \"\",\n \"notes\": \"\",\n \"services\": [\n {\n \"lineId\": \"\",\n \"staffId\": \"\",\n \"position\": \"\",\n \"addOns\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n }\n ],\n \"id\": \"\"\n },\n {\n \"lineId\": \"\",\n \"staffId\": \"\",\n \"position\": \"\",\n \"addOns\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n }\n ],\n \"id\": \"\"\n }\n ],\n \"companyId\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5796cfd5-940c-4356-8bcc-cc9c36671a6a", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "bookings" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "overrideAvailability", "value": "false" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "skipSchedulingNotice", "value": "false" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contactId\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"timezone\": \"\",\n \"serviceLocationId\": \"\",\n \"meetingLocation\": \"\",\n \"calendarId\": \"\",\n \"title\": \"\",\n \"notes\": \"\",\n \"services\": [\n {\n \"staffId\": \"\",\n \"position\": \"\",\n \"addOns\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n }\n ],\n \"id\": \"\"\n },\n {\n \"staffId\": \"\",\n \"position\": \"\",\n \"addOns\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n }\n ],\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ccdf881a-eb69-44e0-b8b0-699390cda987", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "services", "bookings" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "overrideAvailability", "value": "false" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "skipSchedulingNotice", "value": "false" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contactId\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"timezone\": \"\",\n \"serviceLocationId\": \"\",\n \"meetingLocation\": \"\",\n \"calendarId\": \"\",\n \"title\": \"\",\n \"notes\": \"\",\n \"services\": [\n {\n \"staffId\": \"\",\n \"position\": \"\",\n \"addOns\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n }\n ],\n \"id\": \"\"\n },\n {\n \"staffId\": \"\",\n \"position\": \"\",\n \"addOns\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"duration\": \"\"\n }\n ],\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "events", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "2ae73eea-26f8-4443-b7ce-6a0dd602ca4a", "name": "Reschedule an appointment", "request": { "name": "Reschedule an appointment", "description": { "content": "Full replacement of an existing appointment, validated exactly like a creation. The appointment's own current interval is excluded from the occupancy, so moving it by five minutes does not collide with itself. Evento has no `OPTLOCK` column, so `If-Match` is accepted for API symmetry but ignored.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "scheduling", "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Skips the calendar's booking window ÔÇö the minimum scheduling notice (`allowBookingAfter`) and the horizon (`allowBookingFor`). Every other availability rule still applies. Equivalent to GHL `ignoreDateRange`. Recorded on the appointment's `bookingLog`.", "type": "text/plain" }, "key": "ignoreDateRange", "value": "false" }, { "disabled": false, "description": { "content": "Skips the availability check entirely, letting the counter overbook on purpose. The agenda is still locked, so concurrent writes stay serialised. Equivalent to GHL `ignoreFreeSlotValidation`. Recorded on the appointment's `bookingLog`.", "type": "text/plain" }, "key": "ignoreFreeSlotValidation", "value": "false" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Appointment ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Accepted for API symmetry; ignored because Evento has no OPTLOCK column.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"notes\": \"\",\n \"type\": \"OPTICS_APPOINTMENT\",\n \"appointmentStatus\": \"SHOWED\",\n \"statusId\": \"\",\n \"draft\": \"\",\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"employeeId\": \"\",\n \"counterpartyId\": \"\",\n \"appointmentTypeId\": \"\",\n \"appointmentServiceId\": \"\",\n \"calendarId\": \"\",\n \"assignedEmployeeId\": \"\",\n \"rrule\": \"\",\n \"meetingLocation\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "3e3eb36b-b7cf-46fd-bbc8-d95ce1c36e0d", "name": "Appointment rescheduled", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Skips the calendar's booking window ÔÇö the minimum scheduling notice (`allowBookingAfter`) and the horizon (`allowBookingFor`). Every other availability rule still applies. Equivalent to GHL `ignoreDateRange`. Recorded on the appointment's `bookingLog`.", "type": "text/plain" }, "key": "ignoreDateRange", "value": "false" }, { "disabled": false, "description": { "content": "Skips the availability check entirely, letting the counter overbook on purpose. The agenda is still locked, so concurrent writes stay serialised. Equivalent to GHL `ignoreFreeSlotValidation`. Recorded on the appointment's `bookingLog`.", "type": "text/plain" }, "key": "ignoreFreeSlotValidation", "value": "false" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Accepted for API symmetry; ignored because Evento has no OPTLOCK column.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"notes\": \"\",\n \"type\": \"OPTICS_APPOINTMENT\",\n \"appointmentStatus\": \"SHOWED\",\n \"statusId\": \"\",\n \"draft\": \"\",\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"employeeId\": \"\",\n \"counterpartyId\": \"\",\n \"appointmentTypeId\": \"\",\n \"appointmentServiceId\": \"\",\n \"calendarId\": \"\",\n \"assignedEmployeeId\": \"\",\n \"rrule\": \"\",\n \"meetingLocation\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"notes\": \"\",\n \"type\": \"MEETING\",\n \"appointmentStatus\": \"NOT_CONFIRMED\",\n \"statusId\": \"\",\n \"statusName\": \"\",\n \"draft\": \"\",\n \"enabled\": \"\",\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"durationMinutes\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"appointmentTypeId\": \"\",\n \"appointmentTypeName\": \"\",\n \"appointmentServiceId\": \"\",\n \"appointmentServiceName\": \"\",\n \"calendarId\": \"\",\n \"calendarName\": \"\",\n \"assignedEmployeeId\": \"\",\n \"assignedEmployeeName\": \"\",\n \"rrule\": \"\",\n \"meetingLocation\": \"\",\n \"lastAction\": \"\",\n \"bookingLog\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f15e8068-0d9d-47cd-8ddb-1828f3e31b0c", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Skips the calendar's booking window ÔÇö the minimum scheduling notice (`allowBookingAfter`) and the horizon (`allowBookingFor`). Every other availability rule still applies. Equivalent to GHL `ignoreDateRange`. Recorded on the appointment's `bookingLog`.", "type": "text/plain" }, "key": "ignoreDateRange", "value": "false" }, { "disabled": false, "description": { "content": "Skips the availability check entirely, letting the counter overbook on purpose. The agenda is still locked, so concurrent writes stay serialised. Equivalent to GHL `ignoreFreeSlotValidation`. Recorded on the appointment's `bookingLog`.", "type": "text/plain" }, "key": "ignoreFreeSlotValidation", "value": "false" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Accepted for API symmetry; ignored because Evento has no OPTLOCK column.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"notes\": \"\",\n \"type\": \"OPTICS_APPOINTMENT\",\n \"appointmentStatus\": \"SHOWED\",\n \"statusId\": \"\",\n \"draft\": \"\",\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"employeeId\": \"\",\n \"counterpartyId\": \"\",\n \"appointmentTypeId\": \"\",\n \"appointmentServiceId\": \"\",\n \"calendarId\": \"\",\n \"assignedEmployeeId\": \"\",\n \"rrule\": \"\",\n \"meetingLocation\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7e5d0975-1be9-420a-b8cb-454fa06fa986", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Skips the calendar's booking window ÔÇö the minimum scheduling notice (`allowBookingAfter`) and the horizon (`allowBookingFor`). Every other availability rule still applies. Equivalent to GHL `ignoreDateRange`. Recorded on the appointment's `bookingLog`.", "type": "text/plain" }, "key": "ignoreDateRange", "value": "false" }, { "disabled": false, "description": { "content": "Skips the availability check entirely, letting the counter overbook on purpose. The agenda is still locked, so concurrent writes stay serialised. Equivalent to GHL `ignoreFreeSlotValidation`. Recorded on the appointment's `bookingLog`.", "type": "text/plain" }, "key": "ignoreFreeSlotValidation", "value": "false" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Accepted for API symmetry; ignored because Evento has no OPTLOCK column.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"notes\": \"\",\n \"type\": \"OPTICS_APPOINTMENT\",\n \"appointmentStatus\": \"SHOWED\",\n \"statusId\": \"\",\n \"draft\": \"\",\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"employeeId\": \"\",\n \"counterpartyId\": \"\",\n \"appointmentTypeId\": \"\",\n \"appointmentServiceId\": \"\",\n \"calendarId\": \"\",\n \"assignedEmployeeId\": \"\",\n \"rrule\": \"\",\n \"meetingLocation\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "eeb1bc0c-4766-402d-980e-f3a1b6f4fb1b", "name": "Authenticated user is missing the `EDITAR_EVENTO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Skips the calendar's booking window ÔÇö the minimum scheduling notice (`allowBookingAfter`) and the horizon (`allowBookingFor`). Every other availability rule still applies. Equivalent to GHL `ignoreDateRange`. Recorded on the appointment's `bookingLog`.", "type": "text/plain" }, "key": "ignoreDateRange", "value": "false" }, { "disabled": false, "description": { "content": "Skips the availability check entirely, letting the counter overbook on purpose. The agenda is still locked, so concurrent writes stay serialised. Equivalent to GHL `ignoreFreeSlotValidation`. Recorded on the appointment's `bookingLog`.", "type": "text/plain" }, "key": "ignoreFreeSlotValidation", "value": "false" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Accepted for API symmetry; ignored because Evento has no OPTLOCK column.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"notes\": \"\",\n \"type\": \"OPTICS_APPOINTMENT\",\n \"appointmentStatus\": \"SHOWED\",\n \"statusId\": \"\",\n \"draft\": \"\",\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"employeeId\": \"\",\n \"counterpartyId\": \"\",\n \"appointmentTypeId\": \"\",\n \"appointmentServiceId\": \"\",\n \"calendarId\": \"\",\n \"assignedEmployeeId\": \"\",\n \"rrule\": \"\",\n \"meetingLocation\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "304db8b9-16a8-4c89-be36-f6c449e9ccbe", "name": "Appointment not found", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Skips the calendar's booking window ÔÇö the minimum scheduling notice (`allowBookingAfter`) and the horizon (`allowBookingFor`). Every other availability rule still applies. Equivalent to GHL `ignoreDateRange`. Recorded on the appointment's `bookingLog`.", "type": "text/plain" }, "key": "ignoreDateRange", "value": "false" }, { "disabled": false, "description": { "content": "Skips the availability check entirely, letting the counter overbook on purpose. The agenda is still locked, so concurrent writes stay serialised. Equivalent to GHL `ignoreFreeSlotValidation`. Recorded on the appointment's `bookingLog`.", "type": "text/plain" }, "key": "ignoreFreeSlotValidation", "value": "false" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Accepted for API symmetry; ignored because Evento has no OPTLOCK column.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"notes\": \"\",\n \"type\": \"OPTICS_APPOINTMENT\",\n \"appointmentStatus\": \"SHOWED\",\n \"statusId\": \"\",\n \"draft\": \"\",\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"employeeId\": \"\",\n \"counterpartyId\": \"\",\n \"appointmentTypeId\": \"\",\n \"appointmentServiceId\": \"\",\n \"calendarId\": \"\",\n \"assignedEmployeeId\": \"\",\n \"rrule\": \"\",\n \"meetingLocation\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "290753ce-948b-4831-a499-d21467a4824c", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Skips the calendar's booking window ÔÇö the minimum scheduling notice (`allowBookingAfter`) and the horizon (`allowBookingFor`). Every other availability rule still applies. Equivalent to GHL `ignoreDateRange`. Recorded on the appointment's `bookingLog`.", "type": "text/plain" }, "key": "ignoreDateRange", "value": "false" }, { "disabled": false, "description": { "content": "Skips the availability check entirely, letting the counter overbook on purpose. The agenda is still locked, so concurrent writes stay serialised. Equivalent to GHL `ignoreFreeSlotValidation`. Recorded on the appointment's `bookingLog`.", "type": "text/plain" }, "key": "ignoreFreeSlotValidation", "value": "false" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Accepted for API symmetry; ignored because Evento has no OPTLOCK column.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"notes\": \"\",\n \"type\": \"OPTICS_APPOINTMENT\",\n \"appointmentStatus\": \"SHOWED\",\n \"statusId\": \"\",\n \"draft\": \"\",\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"employeeId\": \"\",\n \"counterpartyId\": \"\",\n \"appointmentTypeId\": \"\",\n \"appointmentServiceId\": \"\",\n \"calendarId\": \"\",\n \"assignedEmployeeId\": \"\",\n \"rrule\": \"\",\n \"meetingLocation\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2f5dc615-dedd-406a-b50e-93265a22ce51", "name": "The payload is valid but the engine does not offer that interval. The `detail` names the slots that were available that day. Retry with `ignoreFreeSlotValidation=true` to book it anyway.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Skips the calendar's booking window ÔÇö the minimum scheduling notice (`allowBookingAfter`) and the horizon (`allowBookingFor`). Every other availability rule still applies. Equivalent to GHL `ignoreDateRange`. Recorded on the appointment's `bookingLog`.", "type": "text/plain" }, "key": "ignoreDateRange", "value": "false" }, { "disabled": false, "description": { "content": "Skips the availability check entirely, letting the counter overbook on purpose. The agenda is still locked, so concurrent writes stay serialised. Equivalent to GHL `ignoreFreeSlotValidation`. Recorded on the appointment's `bookingLog`.", "type": "text/plain" }, "key": "ignoreFreeSlotValidation", "value": "false" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Accepted for API symmetry; ignored because Evento has no OPTLOCK column.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"notes\": \"\",\n \"type\": \"OPTICS_APPOINTMENT\",\n \"appointmentStatus\": \"SHOWED\",\n \"statusId\": \"\",\n \"draft\": \"\",\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"employeeId\": \"\",\n \"counterpartyId\": \"\",\n \"appointmentTypeId\": \"\",\n \"appointmentServiceId\": \"\",\n \"calendarId\": \"\",\n \"assignedEmployeeId\": \"\",\n \"rrule\": \"\",\n \"meetingLocation\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8b0c19d5-3d78-42d3-a494-a111da4c0b54", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Skips the calendar's booking window ÔÇö the minimum scheduling notice (`allowBookingAfter`) and the horizon (`allowBookingFor`). Every other availability rule still applies. Equivalent to GHL `ignoreDateRange`. Recorded on the appointment's `bookingLog`.", "type": "text/plain" }, "key": "ignoreDateRange", "value": "false" }, { "disabled": false, "description": { "content": "Skips the availability check entirely, letting the counter overbook on purpose. The agenda is still locked, so concurrent writes stay serialised. Equivalent to GHL `ignoreFreeSlotValidation`. Recorded on the appointment's `bookingLog`.", "type": "text/plain" }, "key": "ignoreFreeSlotValidation", "value": "false" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Accepted for API symmetry; ignored because Evento has no OPTLOCK column.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"notes\": \"\",\n \"type\": \"OPTICS_APPOINTMENT\",\n \"appointmentStatus\": \"SHOWED\",\n \"statusId\": \"\",\n \"draft\": \"\",\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"employeeId\": \"\",\n \"counterpartyId\": \"\",\n \"appointmentTypeId\": \"\",\n \"appointmentServiceId\": \"\",\n \"calendarId\": \"\",\n \"assignedEmployeeId\": \"\",\n \"rrule\": \"\",\n \"meetingLocation\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2a949e6c-5017-468e-b87e-7aff49e65849", "name": "Cancel an appointment", "request": { "name": "Cancel an appointment", "description": { "content": "Cancels the appointment: its status becomes `CANCELLED` (`EstadoEvento.CANC`) and the row is preserved.\n\nThis is deliberately not a physical delete. A cancelled appointment keeps the history of who booked what and when ÔÇö which is what makes a reschedule auditable ÔÇö and lets the CRM connector push the cancellation out instead of finding a dangling reference. The slot is released either way: the availability engine treats `CANCELLED` as free.\n\nCancelling an already cancelled appointment succeeds and changes nothing.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "scheduling", "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Appointment ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Accepted for API symmetry; ignored because Evento has no OPTLOCK column.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "cfd5e077-1b2f-487d-87e6-7c3b7c658617", "name": "Appointment cancelled", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Accepted for API symmetry; ignored because Evento has no OPTLOCK column.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "90d357e9-a55f-4449-9058-818950e9f82d", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Accepted for API symmetry; ignored because Evento has no OPTLOCK column.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d8e81cd5-8a4f-4b72-baa4-d1dc78245ba8", "name": "Authenticated user is missing the `BORRAR_EVENTO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Accepted for API symmetry; ignored because Evento has no OPTLOCK column.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d2f93ab7-3530-4d93-9548-eb212a07e57e", "name": "Appointment not found", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Accepted for API symmetry; ignored because Evento has no OPTLOCK column.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b039cb9e-b2d4-451b-bbfb-ed975d0f0bec", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Accepted for API symmetry; ignored because Evento has no OPTLOCK column.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "28fc3631-3905-4b53-9bdd-49b4c4f2d910", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Accepted for API symmetry; ignored because Evento has no OPTLOCK column.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "block-slots", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "5356a734-040c-4340-8a6d-4220d8e8fac7", "name": "Get block slot by ID", "request": { "name": "Get block slot by ID", "description": { "content": "Returns a single block slot by its primary key.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "scheduling", "events", "block-slots", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Block slot ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "2cf83e37-11b4-4355-a9ab-9ec30b3f8570", "name": "Block slot found", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "events", "block-slots", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Block slot ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"title\": \"\",\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"calendarId\": \"\",\n \"calendarName\": \"\",\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "59a42d4a-fbdd-4f40-b08b-8d56aee29353", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "events", "block-slots", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Block slot ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7275770e-7965-4621-9a0f-e823db6a5fd6", "name": "Authenticated user is missing the `VER_CALENDARIOBLOQUEOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "events", "block-slots", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Block slot ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "083aee6c-44f1-4bb8-b6e9-48e20782fc7a", "name": "Block slot not found", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "events", "block-slots", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Block slot ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "43775b77-372c-4119-93fd-bf7a23ec6a35", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "events", "block-slots", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Block slot ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "61845f51-4564-482b-93a5-bfe66bfbaaf9", "name": "Update block slot", "request": { "name": "Update block slot", "description": { "content": "Full replacement of an existing block slot. The calendarId / employeeId exclusivity rule applies to the new state.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "scheduling", "events", "block-slots", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Block slot ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"calendarId\": \"\",\n \"employeeId\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "afb1da93-9c6c-4db6-9eea-e4d896ee37f3", "name": "Block slot updated", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "events", "block-slots", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Block slot ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"calendarId\": \"\",\n \"employeeId\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"title\": \"\",\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"calendarId\": \"\",\n \"calendarName\": \"\",\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "822d2a0b-911e-4fb2-b947-43dabc99c94f", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "events", "block-slots", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Block slot ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"calendarId\": \"\",\n \"employeeId\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f65b1cb9-722d-4074-83f0-155414114970", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "events", "block-slots", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Block slot ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"calendarId\": \"\",\n \"employeeId\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cfbfb848-14ef-4763-932b-fb38d0b667e3", "name": "Authenticated user is missing the `EDITAR_CALENDARIOBLOQUEOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "events", "block-slots", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Block slot ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"calendarId\": \"\",\n \"employeeId\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5fac7c2e-cb0a-483f-9937-d1982d9dc9fc", "name": "Block slot not found", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "events", "block-slots", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Block slot ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"calendarId\": \"\",\n \"employeeId\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d35a8b00-3802-4075-b74e-330a0b79102a", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "events", "block-slots", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Block slot ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"calendarId\": \"\",\n \"employeeId\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c7ff5926-6fd2-4156-8d53-13e90ac87bf2", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "events", "block-slots", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Block slot ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"calendarId\": \"\",\n \"employeeId\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "74958cf1-dd8a-4a37-b135-653e06d6f5b2", "name": "Delete block slot", "request": { "name": "Delete block slot", "description": { "content": "Removes the block. Unlike appointments, a block has no history worth preserving, so this is a physical delete.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "scheduling", "events", "block-slots", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Block slot ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "a90c6bdb-12c8-4fdd-a16a-bf457e592740", "name": "Block slot deleted", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "events", "block-slots", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Block slot ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c253a924-7db6-4c88-b060-73da86bf50d9", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "events", "block-slots", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Block slot ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3c19c636-fabb-4d42-ba97-005d3ab59a3c", "name": "Authenticated user is missing the `BORRAR_CALENDARIOBLOQUEOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "events", "block-slots", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Block slot ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d602d74e-260a-4237-8944-e7555fd00c90", "name": "Block slot not found", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "events", "block-slots", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Block slot ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3d6b219c-8e4b-4b00-9008-cd47503304ff", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "events", "block-slots", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Block slot ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fad39891-ed0e-429f-8bd4-c51ff42bee81", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "events", "block-slots", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Block slot ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f40e45aa-2d35-4d55-a03c-b2f30a3c012e", "name": "Merge-patch block slot", "request": { "name": "Merge-patch block slot", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "scheduling", "events", "block-slots", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Block slot ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "9713fac5-4faa-4ef4-be8d-04111f0082c4", "name": "Block slot patched", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "events", "block-slots", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Block slot ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"title\": \"\",\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"calendarId\": \"\",\n \"calendarName\": \"\",\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8e4316a4-c4fb-4323-bb7d-f4af7aeed43e", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details. Also returned for malformed merge-patch payloads.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "events", "block-slots", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Block slot ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7f554c12-0551-4a42-8223-a5d5acf4fee5", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "events", "block-slots", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Block slot ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a5a79674-c75d-468e-bded-abbb8a6f15c2", "name": "Authenticated user is missing the `EDITAR_CALENDARIOBLOQUEOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "events", "block-slots", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Block slot ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e8e58f1d-f7c5-4e32-979a-cc4cf98e5bf2", "name": "Block slot not found", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "events", "block-slots", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Block slot ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c2b72141-e39d-44c1-af58-2ba89ac9402f", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "events", "block-slots", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Block slot ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e5683c84-80ff-4eda-89c7-c150954345e3", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "events", "block-slots", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Block slot ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "5619dea5-f735-4324-8394-af747d15f3bd", "name": "List block slots", "request": { "name": "List block slots", "description": { "content": "Returns a paginated list of block slots with envelope `{data, totalCount, skip, limit, hasMore}`. Default sort is `startAt:asc`. Limit is capped at 200; skip is clamped to >= 0.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "scheduling", "events", "block-slots" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "startAt:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "1db101fb-8602-4afc-b715-7cc212b37c40", "name": "Page of block slots", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "events", "block-slots" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "startAt:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a2ea1e9c-7874-4391-b54e-f35ea68cd374", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "events", "block-slots" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "startAt:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1b0c4104-c530-44f0-8f85-e8b72f0875be", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "events", "block-slots" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "startAt:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "75e66099-7c99-47d7-8cca-305c7c8c1642", "name": "Authenticated user is missing the `VER_CALENDARIOBLOQUEOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "events", "block-slots" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "startAt:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "122b52dd-0f5b-4b79-b3cf-26d24e5eee40", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "events", "block-slots" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "startAt:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a3807d82-659b-4898-89d5-51d283c30a6c", "name": "Create block slot", "request": { "name": "Create block slot", "description": { "content": "Creates a block. Exactly one of `calendarId` / `employeeId` must be set; supplying both or neither returns 400. The owning company is derived from the target and must be inside the caller's scope.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "scheduling", "events", "block-slots" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"calendarId\": \"\",\n \"employeeId\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "b2c1b73d-ac5d-457b-bb15-013b87a024cd", "name": "Block slot created", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "events", "block-slots" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"calendarId\": \"\",\n \"employeeId\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"title\": \"\",\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"calendarId\": \"\",\n \"calendarName\": \"\",\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b9f37e69-dd79-48da-b44b-d0ad07dd76d7", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details. Also returned when both or neither of calendarId / employeeId are set.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "events", "block-slots" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"calendarId\": \"\",\n \"employeeId\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "06d3c0a3-0a4d-47ad-8a19-54e0e8f7bfcc", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "events", "block-slots" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"calendarId\": \"\",\n \"employeeId\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "10201961-dd99-4100-a038-00117b83d244", "name": "Authenticated user is missing the `CREAR_CALENDARIOBLOQUEOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "events", "block-slots" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"calendarId\": \"\",\n \"employeeId\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "60c527bc-2d69-446e-a7e1-f1233e6785d1", "name": "Target calendar or employee not found", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "events", "block-slots" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"calendarId\": \"\",\n \"employeeId\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "57263f32-a60b-4336-9668-2a0fdffcd5d4", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "events", "block-slots" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"calendarId\": \"\",\n \"employeeId\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "61abc922-1854-47b0-8e27-f598cd44d07c", "name": "Book an appointment", "request": { "name": "Book an appointment", "description": { "content": "Creates an appointment after checking the requested interval against the availability engine. The check and the insert share one transaction and one pessimistic lock over the calendar's and the assignee's agenda, so a second booking of the same slot waits and is then rejected.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "scheduling", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Skips the calendar's booking window ÔÇö the minimum scheduling notice (`allowBookingAfter`) and the horizon (`allowBookingFor`). Every other availability rule still applies. Equivalent to GHL `ignoreDateRange`. Recorded on the appointment's `bookingLog`.", "type": "text/plain" }, "key": "ignoreDateRange", "value": "false" }, { "disabled": false, "description": { "content": "Skips the availability check entirely, letting the counter overbook on purpose. The agenda is still locked, so concurrent writes stay serialised. Equivalent to GHL `ignoreFreeSlotValidation`. Recorded on the appointment's `bookingLog`.", "type": "text/plain" }, "key": "ignoreFreeSlotValidation", "value": "false" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"notes\": \"\",\n \"type\": \"OPTICS_APPOINTMENT\",\n \"appointmentStatus\": \"SHOWED\",\n \"statusId\": \"\",\n \"draft\": \"\",\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"employeeId\": \"\",\n \"counterpartyId\": \"\",\n \"appointmentTypeId\": \"\",\n \"appointmentServiceId\": \"\",\n \"calendarId\": \"\",\n \"assignedEmployeeId\": \"\",\n \"rrule\": \"\",\n \"meetingLocation\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "0029511c-ef1e-4fcc-a57a-2fd4d024405b", "name": "Appointment booked", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Skips the calendar's booking window ÔÇö the minimum scheduling notice (`allowBookingAfter`) and the horizon (`allowBookingFor`). Every other availability rule still applies. Equivalent to GHL `ignoreDateRange`. Recorded on the appointment's `bookingLog`.", "type": "text/plain" }, "key": "ignoreDateRange", "value": "false" }, { "disabled": false, "description": { "content": "Skips the availability check entirely, letting the counter overbook on purpose. The agenda is still locked, so concurrent writes stay serialised. Equivalent to GHL `ignoreFreeSlotValidation`. Recorded on the appointment's `bookingLog`.", "type": "text/plain" }, "key": "ignoreFreeSlotValidation", "value": "false" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"notes\": \"\",\n \"type\": \"OPTICS_APPOINTMENT\",\n \"appointmentStatus\": \"SHOWED\",\n \"statusId\": \"\",\n \"draft\": \"\",\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"employeeId\": \"\",\n \"counterpartyId\": \"\",\n \"appointmentTypeId\": \"\",\n \"appointmentServiceId\": \"\",\n \"calendarId\": \"\",\n \"assignedEmployeeId\": \"\",\n \"rrule\": \"\",\n \"meetingLocation\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"notes\": \"\",\n \"type\": \"MEETING\",\n \"appointmentStatus\": \"NOT_CONFIRMED\",\n \"statusId\": \"\",\n \"statusName\": \"\",\n \"draft\": \"\",\n \"enabled\": \"\",\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"durationMinutes\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"appointmentTypeId\": \"\",\n \"appointmentTypeName\": \"\",\n \"appointmentServiceId\": \"\",\n \"appointmentServiceName\": \"\",\n \"calendarId\": \"\",\n \"calendarName\": \"\",\n \"assignedEmployeeId\": \"\",\n \"assignedEmployeeName\": \"\",\n \"rrule\": \"\",\n \"meetingLocation\": \"\",\n \"lastAction\": \"\",\n \"bookingLog\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c3b0035e-436b-46c1-8bc1-a633db552931", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Skips the calendar's booking window ÔÇö the minimum scheduling notice (`allowBookingAfter`) and the horizon (`allowBookingFor`). Every other availability rule still applies. Equivalent to GHL `ignoreDateRange`. Recorded on the appointment's `bookingLog`.", "type": "text/plain" }, "key": "ignoreDateRange", "value": "false" }, { "disabled": false, "description": { "content": "Skips the availability check entirely, letting the counter overbook on purpose. The agenda is still locked, so concurrent writes stay serialised. Equivalent to GHL `ignoreFreeSlotValidation`. Recorded on the appointment's `bookingLog`.", "type": "text/plain" }, "key": "ignoreFreeSlotValidation", "value": "false" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"notes\": \"\",\n \"type\": \"OPTICS_APPOINTMENT\",\n \"appointmentStatus\": \"SHOWED\",\n \"statusId\": \"\",\n \"draft\": \"\",\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"employeeId\": \"\",\n \"counterpartyId\": \"\",\n \"appointmentTypeId\": \"\",\n \"appointmentServiceId\": \"\",\n \"calendarId\": \"\",\n \"assignedEmployeeId\": \"\",\n \"rrule\": \"\",\n \"meetingLocation\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "400332f3-adb5-442d-b961-e55c737004ca", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Skips the calendar's booking window ÔÇö the minimum scheduling notice (`allowBookingAfter`) and the horizon (`allowBookingFor`). Every other availability rule still applies. Equivalent to GHL `ignoreDateRange`. Recorded on the appointment's `bookingLog`.", "type": "text/plain" }, "key": "ignoreDateRange", "value": "false" }, { "disabled": false, "description": { "content": "Skips the availability check entirely, letting the counter overbook on purpose. The agenda is still locked, so concurrent writes stay serialised. Equivalent to GHL `ignoreFreeSlotValidation`. Recorded on the appointment's `bookingLog`.", "type": "text/plain" }, "key": "ignoreFreeSlotValidation", "value": "false" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"notes\": \"\",\n \"type\": \"OPTICS_APPOINTMENT\",\n \"appointmentStatus\": \"SHOWED\",\n \"statusId\": \"\",\n \"draft\": \"\",\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"employeeId\": \"\",\n \"counterpartyId\": \"\",\n \"appointmentTypeId\": \"\",\n \"appointmentServiceId\": \"\",\n \"calendarId\": \"\",\n \"assignedEmployeeId\": \"\",\n \"rrule\": \"\",\n \"meetingLocation\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8f6f0172-e1c2-452d-809e-342f3f6ee858", "name": "Authenticated user is missing the `CREAR_EVENTO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Skips the calendar's booking window ÔÇö the minimum scheduling notice (`allowBookingAfter`) and the horizon (`allowBookingFor`). Every other availability rule still applies. Equivalent to GHL `ignoreDateRange`. Recorded on the appointment's `bookingLog`.", "type": "text/plain" }, "key": "ignoreDateRange", "value": "false" }, { "disabled": false, "description": { "content": "Skips the availability check entirely, letting the counter overbook on purpose. The agenda is still locked, so concurrent writes stay serialised. Equivalent to GHL `ignoreFreeSlotValidation`. Recorded on the appointment's `bookingLog`.", "type": "text/plain" }, "key": "ignoreFreeSlotValidation", "value": "false" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"notes\": \"\",\n \"type\": \"OPTICS_APPOINTMENT\",\n \"appointmentStatus\": \"SHOWED\",\n \"statusId\": \"\",\n \"draft\": \"\",\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"employeeId\": \"\",\n \"counterpartyId\": \"\",\n \"appointmentTypeId\": \"\",\n \"appointmentServiceId\": \"\",\n \"calendarId\": \"\",\n \"assignedEmployeeId\": \"\",\n \"rrule\": \"\",\n \"meetingLocation\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "03f84708-7aff-4c69-b797-d2f75497a760", "name": "Calendar, branch or related entity not found", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Skips the calendar's booking window ÔÇö the minimum scheduling notice (`allowBookingAfter`) and the horizon (`allowBookingFor`). Every other availability rule still applies. Equivalent to GHL `ignoreDateRange`. Recorded on the appointment's `bookingLog`.", "type": "text/plain" }, "key": "ignoreDateRange", "value": "false" }, { "disabled": false, "description": { "content": "Skips the availability check entirely, letting the counter overbook on purpose. The agenda is still locked, so concurrent writes stay serialised. Equivalent to GHL `ignoreFreeSlotValidation`. Recorded on the appointment's `bookingLog`.", "type": "text/plain" }, "key": "ignoreFreeSlotValidation", "value": "false" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"notes\": \"\",\n \"type\": \"OPTICS_APPOINTMENT\",\n \"appointmentStatus\": \"SHOWED\",\n \"statusId\": \"\",\n \"draft\": \"\",\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"employeeId\": \"\",\n \"counterpartyId\": \"\",\n \"appointmentTypeId\": \"\",\n \"appointmentServiceId\": \"\",\n \"calendarId\": \"\",\n \"assignedEmployeeId\": \"\",\n \"rrule\": \"\",\n \"meetingLocation\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "aa90897d-47f7-4f7e-b78e-0df929d15549", "name": "The payload is valid but the engine does not offer that interval. The `detail` names the slots that were available that day. Retry with `ignoreFreeSlotValidation=true` to book it anyway.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Skips the calendar's booking window ÔÇö the minimum scheduling notice (`allowBookingAfter`) and the horizon (`allowBookingFor`). Every other availability rule still applies. Equivalent to GHL `ignoreDateRange`. Recorded on the appointment's `bookingLog`.", "type": "text/plain" }, "key": "ignoreDateRange", "value": "false" }, { "disabled": false, "description": { "content": "Skips the availability check entirely, letting the counter overbook on purpose. The agenda is still locked, so concurrent writes stay serialised. Equivalent to GHL `ignoreFreeSlotValidation`. Recorded on the appointment's `bookingLog`.", "type": "text/plain" }, "key": "ignoreFreeSlotValidation", "value": "false" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"notes\": \"\",\n \"type\": \"OPTICS_APPOINTMENT\",\n \"appointmentStatus\": \"SHOWED\",\n \"statusId\": \"\",\n \"draft\": \"\",\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"employeeId\": \"\",\n \"counterpartyId\": \"\",\n \"appointmentTypeId\": \"\",\n \"appointmentServiceId\": \"\",\n \"calendarId\": \"\",\n \"assignedEmployeeId\": \"\",\n \"rrule\": \"\",\n \"meetingLocation\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d2f2a512-230f-42cd-aaa8-d1fad6a89baf", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Skips the calendar's booking window ÔÇö the minimum scheduling notice (`allowBookingAfter`) and the horizon (`allowBookingFor`). Every other availability rule still applies. Equivalent to GHL `ignoreDateRange`. Recorded on the appointment's `bookingLog`.", "type": "text/plain" }, "key": "ignoreDateRange", "value": "false" }, { "disabled": false, "description": { "content": "Skips the availability check entirely, letting the counter overbook on purpose. The agenda is still locked, so concurrent writes stay serialised. Equivalent to GHL `ignoreFreeSlotValidation`. Recorded on the appointment's `bookingLog`.", "type": "text/plain" }, "key": "ignoreFreeSlotValidation", "value": "false" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"notes\": \"\",\n \"type\": \"OPTICS_APPOINTMENT\",\n \"appointmentStatus\": \"SHOWED\",\n \"statusId\": \"\",\n \"draft\": \"\",\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"employeeId\": \"\",\n \"counterpartyId\": \"\",\n \"appointmentTypeId\": \"\",\n \"appointmentServiceId\": \"\",\n \"calendarId\": \"\",\n \"assignedEmployeeId\": \"\",\n \"rrule\": \"\",\n \"meetingLocation\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "calendars", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "ef037009-dd34-4bfc-bb6c-104a08d644f9", "name": "Get calendar by ID", "request": { "name": "Get calendar by ID", "description": { "content": "Returns a single calendar with the full GHL-like contract.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "scheduling", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "62924527-295a-4347-bf5a-68c829d8d288", "name": "Calendar found", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"widgetSlug\": \"\",\n \"widgetType\": \"default\",\n \"eventTitle\": \"\",\n \"color\": \"\",\n \"active\": \"\",\n \"enabled\": \"\",\n \"groupId\": \"\",\n \"groupName\": \"\",\n \"calendarType\": \"service_booking\",\n \"legacyCalendarType\": \"SERVICIO\",\n \"eventType\": \"RoundRobin_OptimizeForEqualDistribution\",\n \"teamMembers\": [\n {\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"custom\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"inbound_call\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n },\n {\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"booker\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n }\n ],\n \"employeeIds\": [\n \"\",\n \"\"\n ],\n \"slotDuration\": \"\",\n \"slotDurationUnit\": \"hours\",\n \"defaultDurationMinutes\": \"\",\n \"slotMinutes\": \"\",\n \"defaultView\": \"DIA\",\n \"timeUnit\": \"MINUTES\",\n \"predefinedSlots\": \"\",\n \"slotInterval\": \"\",\n \"slotIntervalUnit\": \"\",\n \"slotBuffer\": \"\",\n \"slotBufferUnit\": \"\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"\",\n \"appoinmentPerSlot\": \"\",\n \"appoinmentPerDay\": \"\",\n \"allowBookingAfter\": \"\",\n \"allowBookingAfterUnit\": \"\",\n \"allowBookingFor\": \"\",\n \"allowBookingForUnit\": \"\",\n \"openHours\": [\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n },\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n }\n ],\n \"availabilities\": [\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n },\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n }\n ],\n \"availabilityType\": \"\",\n \"openingTime\": \"\",\n \"closingTime\": \"\",\n \"enableRecurring\": \"\",\n \"recurring\": {\n \"freq\": \"WEEKLY\",\n \"count\": \"\",\n \"bookingOption\": \"book_next\",\n \"bookingOverlapDefaultStatus\": \"new\"\n },\n \"lookBusyConfig\": {\n \"enabled\": \"\",\n \"LookBusyPercentage\": \"\"\n },\n \"formId\": \"\",\n \"formSubmitType\": \"RedirectURL\",\n \"formSubmitRedirectUrl\": \"\",\n \"formSubmitThanksMessage\": \"\",\n \"autoConfirm\": \"\",\n \"allowReschedule\": \"\",\n \"allowCancellation\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "52fef9de-34b0-4568-967d-19f4a97872ed", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e612c6c0-098d-4533-b9ae-3304ee032935", "name": "Authenticated user is missing the `VER_CALENDARIOUI` permission", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "644f445c-a934-4656-8d42-5904b6fbfe4e", "name": "Calendar not found", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ef1f56e9-9111-4298-939a-57dafc7cf31f", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "57a4a4b2-c4d2-4229-849e-91199bb1b809", "name": "Update calendar", "request": { "name": "Update calendar", "description": { "content": "Full replacement of an existing calendar (GHL-like contract).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "scheduling", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"widgetSlug\": \"\",\n \"widgetType\": \"classic\",\n \"eventTitle\": \"\",\n \"color\": \"\",\n \"active\": \"\",\n \"enabled\": \"\",\n \"groupId\": \"\",\n \"calendarType\": \"event\",\n \"legacyCalendarType\": \"SERVICIO\",\n \"eventType\": \"RoundRobin_OptimizeForEqualDistribution\",\n \"teamMembers\": [\n {\n \"employeeId\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"zoom_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n },\n {\n \"employeeId\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"inbound_call\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n }\n ],\n \"employeeIds\": [\n \"\",\n \"\"\n ],\n \"slotDuration\": \"\",\n \"slotDurationUnit\": \"mins\",\n \"defaultDurationMinutes\": \"\",\n \"slotMinutes\": \"\",\n \"defaultView\": \"MES\",\n \"timeUnit\": \"MINUTES\",\n \"predefinedSlots\": \"\",\n \"slotInterval\": \"\",\n \"slotIntervalUnit\": \"\",\n \"slotBuffer\": \"\",\n \"slotBufferUnit\": \"\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"\",\n \"appoinmentPerSlot\": \"\",\n \"appoinmentPerDay\": \"\",\n \"allowBookingAfter\": \"\",\n \"allowBookingAfterUnit\": \"\",\n \"allowBookingFor\": \"\",\n \"allowBookingForUnit\": \"\",\n \"openHours\": [\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n },\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n }\n ],\n \"availabilities\": [\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n },\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n }\n ],\n \"availabilityType\": \"\",\n \"openingTime\": \"\",\n \"closingTime\": \"\",\n \"enableRecurring\": \"\",\n \"recurring\": {\n \"freq\": \"WEEKLY\",\n \"count\": \"\",\n \"bookingOption\": \"book_next\",\n \"bookingOverlapDefaultStatus\": \"new\"\n },\n \"lookBusyConfig\": {\n \"enabled\": \"\",\n \"LookBusyPercentage\": \"\"\n },\n \"formId\": \"\",\n \"formSubmitType\": \"ThankYouMessage\",\n \"formSubmitRedirectUrl\": \"\",\n \"formSubmitThanksMessage\": \"\",\n \"autoConfirm\": \"\",\n \"allowReschedule\": \"\",\n \"allowCancellation\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "f006db45-03ab-4757-a9fc-29b3b9efb6f0", "name": "Calendar updated", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"widgetSlug\": \"\",\n \"widgetType\": \"classic\",\n \"eventTitle\": \"\",\n \"color\": \"\",\n \"active\": \"\",\n \"enabled\": \"\",\n \"groupId\": \"\",\n \"calendarType\": \"event\",\n \"legacyCalendarType\": \"SERVICIO\",\n \"eventType\": \"RoundRobin_OptimizeForEqualDistribution\",\n \"teamMembers\": [\n {\n \"employeeId\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"zoom_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n },\n {\n \"employeeId\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"inbound_call\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n }\n ],\n \"employeeIds\": [\n \"\",\n \"\"\n ],\n \"slotDuration\": \"\",\n \"slotDurationUnit\": \"mins\",\n \"defaultDurationMinutes\": \"\",\n \"slotMinutes\": \"\",\n \"defaultView\": \"MES\",\n \"timeUnit\": \"MINUTES\",\n \"predefinedSlots\": \"\",\n \"slotInterval\": \"\",\n \"slotIntervalUnit\": \"\",\n \"slotBuffer\": \"\",\n \"slotBufferUnit\": \"\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"\",\n \"appoinmentPerSlot\": \"\",\n \"appoinmentPerDay\": \"\",\n \"allowBookingAfter\": \"\",\n \"allowBookingAfterUnit\": \"\",\n \"allowBookingFor\": \"\",\n \"allowBookingForUnit\": \"\",\n \"openHours\": [\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n },\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n }\n ],\n \"availabilities\": [\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n },\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n }\n ],\n \"availabilityType\": \"\",\n \"openingTime\": \"\",\n \"closingTime\": \"\",\n \"enableRecurring\": \"\",\n \"recurring\": {\n \"freq\": \"WEEKLY\",\n \"count\": \"\",\n \"bookingOption\": \"book_next\",\n \"bookingOverlapDefaultStatus\": \"new\"\n },\n \"lookBusyConfig\": {\n \"enabled\": \"\",\n \"LookBusyPercentage\": \"\"\n },\n \"formId\": \"\",\n \"formSubmitType\": \"ThankYouMessage\",\n \"formSubmitRedirectUrl\": \"\",\n \"formSubmitThanksMessage\": \"\",\n \"autoConfirm\": \"\",\n \"allowReschedule\": \"\",\n \"allowCancellation\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"widgetSlug\": \"\",\n \"widgetType\": \"default\",\n \"eventTitle\": \"\",\n \"color\": \"\",\n \"active\": \"\",\n \"enabled\": \"\",\n \"groupId\": \"\",\n \"groupName\": \"\",\n \"calendarType\": \"service_booking\",\n \"legacyCalendarType\": \"SERVICIO\",\n \"eventType\": \"RoundRobin_OptimizeForEqualDistribution\",\n \"teamMembers\": [\n {\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"custom\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"inbound_call\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n },\n {\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"booker\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n }\n ],\n \"employeeIds\": [\n \"\",\n \"\"\n ],\n \"slotDuration\": \"\",\n \"slotDurationUnit\": \"hours\",\n \"defaultDurationMinutes\": \"\",\n \"slotMinutes\": \"\",\n \"defaultView\": \"DIA\",\n \"timeUnit\": \"MINUTES\",\n \"predefinedSlots\": \"\",\n \"slotInterval\": \"\",\n \"slotIntervalUnit\": \"\",\n \"slotBuffer\": \"\",\n \"slotBufferUnit\": \"\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"\",\n \"appoinmentPerSlot\": \"\",\n \"appoinmentPerDay\": \"\",\n \"allowBookingAfter\": \"\",\n \"allowBookingAfterUnit\": \"\",\n \"allowBookingFor\": \"\",\n \"allowBookingForUnit\": \"\",\n \"openHours\": [\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n },\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n }\n ],\n \"availabilities\": [\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n },\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n }\n ],\n \"availabilityType\": \"\",\n \"openingTime\": \"\",\n \"closingTime\": \"\",\n \"enableRecurring\": \"\",\n \"recurring\": {\n \"freq\": \"WEEKLY\",\n \"count\": \"\",\n \"bookingOption\": \"book_next\",\n \"bookingOverlapDefaultStatus\": \"new\"\n },\n \"lookBusyConfig\": {\n \"enabled\": \"\",\n \"LookBusyPercentage\": \"\"\n },\n \"formId\": \"\",\n \"formSubmitType\": \"RedirectURL\",\n \"formSubmitRedirectUrl\": \"\",\n \"formSubmitThanksMessage\": \"\",\n \"autoConfirm\": \"\",\n \"allowReschedule\": \"\",\n \"allowCancellation\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fe781795-8748-492c-ad54-74494d314312", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"widgetSlug\": \"\",\n \"widgetType\": \"classic\",\n \"eventTitle\": \"\",\n \"color\": \"\",\n \"active\": \"\",\n \"enabled\": \"\",\n \"groupId\": \"\",\n \"calendarType\": \"event\",\n \"legacyCalendarType\": \"SERVICIO\",\n \"eventType\": \"RoundRobin_OptimizeForEqualDistribution\",\n \"teamMembers\": [\n {\n \"employeeId\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"zoom_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n },\n {\n \"employeeId\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"inbound_call\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n }\n ],\n \"employeeIds\": [\n \"\",\n \"\"\n ],\n \"slotDuration\": \"\",\n \"slotDurationUnit\": \"mins\",\n \"defaultDurationMinutes\": \"\",\n \"slotMinutes\": \"\",\n \"defaultView\": \"MES\",\n \"timeUnit\": \"MINUTES\",\n \"predefinedSlots\": \"\",\n \"slotInterval\": \"\",\n \"slotIntervalUnit\": \"\",\n \"slotBuffer\": \"\",\n \"slotBufferUnit\": \"\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"\",\n \"appoinmentPerSlot\": \"\",\n \"appoinmentPerDay\": \"\",\n \"allowBookingAfter\": \"\",\n \"allowBookingAfterUnit\": \"\",\n \"allowBookingFor\": \"\",\n \"allowBookingForUnit\": \"\",\n \"openHours\": [\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n },\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n }\n ],\n \"availabilities\": [\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n },\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n }\n ],\n \"availabilityType\": \"\",\n \"openingTime\": \"\",\n \"closingTime\": \"\",\n \"enableRecurring\": \"\",\n \"recurring\": {\n \"freq\": \"WEEKLY\",\n \"count\": \"\",\n \"bookingOption\": \"book_next\",\n \"bookingOverlapDefaultStatus\": \"new\"\n },\n \"lookBusyConfig\": {\n \"enabled\": \"\",\n \"LookBusyPercentage\": \"\"\n },\n \"formId\": \"\",\n \"formSubmitType\": \"ThankYouMessage\",\n \"formSubmitRedirectUrl\": \"\",\n \"formSubmitThanksMessage\": \"\",\n \"autoConfirm\": \"\",\n \"allowReschedule\": \"\",\n \"allowCancellation\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "13bd28fa-4840-4e1d-8140-ac6c34bd4dcc", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"widgetSlug\": \"\",\n \"widgetType\": \"classic\",\n \"eventTitle\": \"\",\n \"color\": \"\",\n \"active\": \"\",\n \"enabled\": \"\",\n \"groupId\": \"\",\n \"calendarType\": \"event\",\n \"legacyCalendarType\": \"SERVICIO\",\n \"eventType\": \"RoundRobin_OptimizeForEqualDistribution\",\n \"teamMembers\": [\n {\n \"employeeId\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"zoom_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n },\n {\n \"employeeId\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"inbound_call\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n }\n ],\n \"employeeIds\": [\n \"\",\n \"\"\n ],\n \"slotDuration\": \"\",\n \"slotDurationUnit\": \"mins\",\n \"defaultDurationMinutes\": \"\",\n \"slotMinutes\": \"\",\n \"defaultView\": \"MES\",\n \"timeUnit\": \"MINUTES\",\n \"predefinedSlots\": \"\",\n \"slotInterval\": \"\",\n \"slotIntervalUnit\": \"\",\n \"slotBuffer\": \"\",\n \"slotBufferUnit\": \"\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"\",\n \"appoinmentPerSlot\": \"\",\n \"appoinmentPerDay\": \"\",\n \"allowBookingAfter\": \"\",\n \"allowBookingAfterUnit\": \"\",\n \"allowBookingFor\": \"\",\n \"allowBookingForUnit\": \"\",\n \"openHours\": [\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n },\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n }\n ],\n \"availabilities\": [\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n },\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n }\n ],\n \"availabilityType\": \"\",\n \"openingTime\": \"\",\n \"closingTime\": \"\",\n \"enableRecurring\": \"\",\n \"recurring\": {\n \"freq\": \"WEEKLY\",\n \"count\": \"\",\n \"bookingOption\": \"book_next\",\n \"bookingOverlapDefaultStatus\": \"new\"\n },\n \"lookBusyConfig\": {\n \"enabled\": \"\",\n \"LookBusyPercentage\": \"\"\n },\n \"formId\": \"\",\n \"formSubmitType\": \"ThankYouMessage\",\n \"formSubmitRedirectUrl\": \"\",\n \"formSubmitThanksMessage\": \"\",\n \"autoConfirm\": \"\",\n \"allowReschedule\": \"\",\n \"allowCancellation\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "24220170-97f0-42aa-9011-a99ffb3185a6", "name": "Authenticated user is missing the `EDITAR_CALENDARIOUI` permission", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"widgetSlug\": \"\",\n \"widgetType\": \"classic\",\n \"eventTitle\": \"\",\n \"color\": \"\",\n \"active\": \"\",\n \"enabled\": \"\",\n \"groupId\": \"\",\n \"calendarType\": \"event\",\n \"legacyCalendarType\": \"SERVICIO\",\n \"eventType\": \"RoundRobin_OptimizeForEqualDistribution\",\n \"teamMembers\": [\n {\n \"employeeId\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"zoom_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n },\n {\n \"employeeId\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"inbound_call\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n }\n ],\n \"employeeIds\": [\n \"\",\n \"\"\n ],\n \"slotDuration\": \"\",\n \"slotDurationUnit\": \"mins\",\n \"defaultDurationMinutes\": \"\",\n \"slotMinutes\": \"\",\n \"defaultView\": \"MES\",\n \"timeUnit\": \"MINUTES\",\n \"predefinedSlots\": \"\",\n \"slotInterval\": \"\",\n \"slotIntervalUnit\": \"\",\n \"slotBuffer\": \"\",\n \"slotBufferUnit\": \"\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"\",\n \"appoinmentPerSlot\": \"\",\n \"appoinmentPerDay\": \"\",\n \"allowBookingAfter\": \"\",\n \"allowBookingAfterUnit\": \"\",\n \"allowBookingFor\": \"\",\n \"allowBookingForUnit\": \"\",\n \"openHours\": [\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n },\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n }\n ],\n \"availabilities\": [\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n },\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n }\n ],\n \"availabilityType\": \"\",\n \"openingTime\": \"\",\n \"closingTime\": \"\",\n \"enableRecurring\": \"\",\n \"recurring\": {\n \"freq\": \"WEEKLY\",\n \"count\": \"\",\n \"bookingOption\": \"book_next\",\n \"bookingOverlapDefaultStatus\": \"new\"\n },\n \"lookBusyConfig\": {\n \"enabled\": \"\",\n \"LookBusyPercentage\": \"\"\n },\n \"formId\": \"\",\n \"formSubmitType\": \"ThankYouMessage\",\n \"formSubmitRedirectUrl\": \"\",\n \"formSubmitThanksMessage\": \"\",\n \"autoConfirm\": \"\",\n \"allowReschedule\": \"\",\n \"allowCancellation\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e630db47-3df5-4125-bc05-e8952fea8937", "name": "Calendar not found", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"widgetSlug\": \"\",\n \"widgetType\": \"classic\",\n \"eventTitle\": \"\",\n \"color\": \"\",\n \"active\": \"\",\n \"enabled\": \"\",\n \"groupId\": \"\",\n \"calendarType\": \"event\",\n \"legacyCalendarType\": \"SERVICIO\",\n \"eventType\": \"RoundRobin_OptimizeForEqualDistribution\",\n \"teamMembers\": [\n {\n \"employeeId\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"zoom_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n },\n {\n \"employeeId\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"inbound_call\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n }\n ],\n \"employeeIds\": [\n \"\",\n \"\"\n ],\n \"slotDuration\": \"\",\n \"slotDurationUnit\": \"mins\",\n \"defaultDurationMinutes\": \"\",\n \"slotMinutes\": \"\",\n \"defaultView\": \"MES\",\n \"timeUnit\": \"MINUTES\",\n \"predefinedSlots\": \"\",\n \"slotInterval\": \"\",\n \"slotIntervalUnit\": \"\",\n \"slotBuffer\": \"\",\n \"slotBufferUnit\": \"\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"\",\n \"appoinmentPerSlot\": \"\",\n \"appoinmentPerDay\": \"\",\n \"allowBookingAfter\": \"\",\n \"allowBookingAfterUnit\": \"\",\n \"allowBookingFor\": \"\",\n \"allowBookingForUnit\": \"\",\n \"openHours\": [\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n },\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n }\n ],\n \"availabilities\": [\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n },\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n }\n ],\n \"availabilityType\": \"\",\n \"openingTime\": \"\",\n \"closingTime\": \"\",\n \"enableRecurring\": \"\",\n \"recurring\": {\n \"freq\": \"WEEKLY\",\n \"count\": \"\",\n \"bookingOption\": \"book_next\",\n \"bookingOverlapDefaultStatus\": \"new\"\n },\n \"lookBusyConfig\": {\n \"enabled\": \"\",\n \"LookBusyPercentage\": \"\"\n },\n \"formId\": \"\",\n \"formSubmitType\": \"ThankYouMessage\",\n \"formSubmitRedirectUrl\": \"\",\n \"formSubmitThanksMessage\": \"\",\n \"autoConfirm\": \"\",\n \"allowReschedule\": \"\",\n \"allowCancellation\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bccb240b-7884-4728-b1b9-bc5f15ecaa45", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"widgetSlug\": \"\",\n \"widgetType\": \"classic\",\n \"eventTitle\": \"\",\n \"color\": \"\",\n \"active\": \"\",\n \"enabled\": \"\",\n \"groupId\": \"\",\n \"calendarType\": \"event\",\n \"legacyCalendarType\": \"SERVICIO\",\n \"eventType\": \"RoundRobin_OptimizeForEqualDistribution\",\n \"teamMembers\": [\n {\n \"employeeId\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"zoom_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n },\n {\n \"employeeId\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"inbound_call\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n }\n ],\n \"employeeIds\": [\n \"\",\n \"\"\n ],\n \"slotDuration\": \"\",\n \"slotDurationUnit\": \"mins\",\n \"defaultDurationMinutes\": \"\",\n \"slotMinutes\": \"\",\n \"defaultView\": \"MES\",\n \"timeUnit\": \"MINUTES\",\n \"predefinedSlots\": \"\",\n \"slotInterval\": \"\",\n \"slotIntervalUnit\": \"\",\n \"slotBuffer\": \"\",\n \"slotBufferUnit\": \"\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"\",\n \"appoinmentPerSlot\": \"\",\n \"appoinmentPerDay\": \"\",\n \"allowBookingAfter\": \"\",\n \"allowBookingAfterUnit\": \"\",\n \"allowBookingFor\": \"\",\n \"allowBookingForUnit\": \"\",\n \"openHours\": [\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n },\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n }\n ],\n \"availabilities\": [\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n },\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n }\n ],\n \"availabilityType\": \"\",\n \"openingTime\": \"\",\n \"closingTime\": \"\",\n \"enableRecurring\": \"\",\n \"recurring\": {\n \"freq\": \"WEEKLY\",\n \"count\": \"\",\n \"bookingOption\": \"book_next\",\n \"bookingOverlapDefaultStatus\": \"new\"\n },\n \"lookBusyConfig\": {\n \"enabled\": \"\",\n \"LookBusyPercentage\": \"\"\n },\n \"formId\": \"\",\n \"formSubmitType\": \"ThankYouMessage\",\n \"formSubmitRedirectUrl\": \"\",\n \"formSubmitThanksMessage\": \"\",\n \"autoConfirm\": \"\",\n \"allowReschedule\": \"\",\n \"allowCancellation\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "92252600-949b-48f2-941c-a8d4d5e98f45", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"widgetSlug\": \"\",\n \"widgetType\": \"classic\",\n \"eventTitle\": \"\",\n \"color\": \"\",\n \"active\": \"\",\n \"enabled\": \"\",\n \"groupId\": \"\",\n \"calendarType\": \"event\",\n \"legacyCalendarType\": \"SERVICIO\",\n \"eventType\": \"RoundRobin_OptimizeForEqualDistribution\",\n \"teamMembers\": [\n {\n \"employeeId\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"zoom_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n },\n {\n \"employeeId\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"inbound_call\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n }\n ],\n \"employeeIds\": [\n \"\",\n \"\"\n ],\n \"slotDuration\": \"\",\n \"slotDurationUnit\": \"mins\",\n \"defaultDurationMinutes\": \"\",\n \"slotMinutes\": \"\",\n \"defaultView\": \"MES\",\n \"timeUnit\": \"MINUTES\",\n \"predefinedSlots\": \"\",\n \"slotInterval\": \"\",\n \"slotIntervalUnit\": \"\",\n \"slotBuffer\": \"\",\n \"slotBufferUnit\": \"\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"\",\n \"appoinmentPerSlot\": \"\",\n \"appoinmentPerDay\": \"\",\n \"allowBookingAfter\": \"\",\n \"allowBookingAfterUnit\": \"\",\n \"allowBookingFor\": \"\",\n \"allowBookingForUnit\": \"\",\n \"openHours\": [\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n },\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n }\n ],\n \"availabilities\": [\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n },\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n }\n ],\n \"availabilityType\": \"\",\n \"openingTime\": \"\",\n \"closingTime\": \"\",\n \"enableRecurring\": \"\",\n \"recurring\": {\n \"freq\": \"WEEKLY\",\n \"count\": \"\",\n \"bookingOption\": \"book_next\",\n \"bookingOverlapDefaultStatus\": \"new\"\n },\n \"lookBusyConfig\": {\n \"enabled\": \"\",\n \"LookBusyPercentage\": \"\"\n },\n \"formId\": \"\",\n \"formSubmitType\": \"ThankYouMessage\",\n \"formSubmitRedirectUrl\": \"\",\n \"formSubmitThanksMessage\": \"\",\n \"autoConfirm\": \"\",\n \"allowReschedule\": \"\",\n \"allowCancellation\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1ec34e64-1237-4e69-91a2-6b6fc55b6e72", "name": "Delete calendar", "request": { "name": "Delete calendar", "description": { "content": "Deletes a calendar via the WAR command gateway.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "scheduling", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "f83af81b-8e8f-4c03-a066-0edd1ceb6f2f", "name": "Calendar deleted", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7de90c99-4130-4768-ad5c-3c1a828ba7cc", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1c84f334-c84d-4e3a-9078-7fd25df61dee", "name": "Authenticated user is missing the `BORRAR_CALENDARIOUI` permission", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "88970377-16a7-479a-bafb-f8e6c9845f7f", "name": "Calendar not found", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e0056261-e7e5-427c-9cfa-8aaf4a7f67db", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "525355d2-e860-4f4a-951d-b8a2c1fbc013", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "377b5bbc-5652-45f2-850f-ad8c69bea0ea", "name": "Merge-patch calendar", "request": { "name": "Merge-patch calendar", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "scheduling", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "20f6bcb9-1c12-4861-a8e7-b2f494fc3266", "name": "Calendar patched", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"widgetSlug\": \"\",\n \"widgetType\": \"default\",\n \"eventTitle\": \"\",\n \"color\": \"\",\n \"active\": \"\",\n \"enabled\": \"\",\n \"groupId\": \"\",\n \"groupName\": \"\",\n \"calendarType\": \"service_booking\",\n \"legacyCalendarType\": \"SERVICIO\",\n \"eventType\": \"RoundRobin_OptimizeForEqualDistribution\",\n \"teamMembers\": [\n {\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"custom\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"inbound_call\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n },\n {\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"booker\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n }\n ],\n \"employeeIds\": [\n \"\",\n \"\"\n ],\n \"slotDuration\": \"\",\n \"slotDurationUnit\": \"hours\",\n \"defaultDurationMinutes\": \"\",\n \"slotMinutes\": \"\",\n \"defaultView\": \"DIA\",\n \"timeUnit\": \"MINUTES\",\n \"predefinedSlots\": \"\",\n \"slotInterval\": \"\",\n \"slotIntervalUnit\": \"\",\n \"slotBuffer\": \"\",\n \"slotBufferUnit\": \"\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"\",\n \"appoinmentPerSlot\": \"\",\n \"appoinmentPerDay\": \"\",\n \"allowBookingAfter\": \"\",\n \"allowBookingAfterUnit\": \"\",\n \"allowBookingFor\": \"\",\n \"allowBookingForUnit\": \"\",\n \"openHours\": [\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n },\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n }\n ],\n \"availabilities\": [\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n },\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n }\n ],\n \"availabilityType\": \"\",\n \"openingTime\": \"\",\n \"closingTime\": \"\",\n \"enableRecurring\": \"\",\n \"recurring\": {\n \"freq\": \"WEEKLY\",\n \"count\": \"\",\n \"bookingOption\": \"book_next\",\n \"bookingOverlapDefaultStatus\": \"new\"\n },\n \"lookBusyConfig\": {\n \"enabled\": \"\",\n \"LookBusyPercentage\": \"\"\n },\n \"formId\": \"\",\n \"formSubmitType\": \"RedirectURL\",\n \"formSubmitRedirectUrl\": \"\",\n \"formSubmitThanksMessage\": \"\",\n \"autoConfirm\": \"\",\n \"allowReschedule\": \"\",\n \"allowCancellation\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e8ed1076-6bd0-4d87-bc87-6a894e26ec9f", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details. Also returned for malformed merge-patch payloads.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "977ee7bb-6657-4e8f-8590-6efad171f2e0", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "05168617-bc86-40d0-a10c-a9259c0750cc", "name": "Authenticated user is missing the `EDITAR_CALENDARIOUI` permission", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3f4691b8-3eb1-44e9-ad28-5acc199a2dd5", "name": "Calendar not found", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "00d49ca4-a05e-4c3c-916d-b7c415a13e11", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ef0499e9-44f5-41c9-ad95-13c0a017efbe", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "free-slots", "description": "", "item": [ { "id": "cb221bef-2896-4d24-bc75-33b9e1712557", "name": "Get free slots of a calendar", "request": { "name": "Get free slots of a calendar", "description": { "content": "Returns the bookable slots of a calendar for a date range, grouped by day.\n\nThe whole computation is performed by `gesmo-scheduling-core`, the same engine the booking guard uses on write, so what this endpoint offers and what a `POST /api/v2/scheduling/events` accepts cannot drift apart.\n\n`timezone` is mandatory and explicit: the grid is built in the IANA zone you ask for and `startAt` / `endAt` carry that zone's offset. There is no server default ÔÇö tenants live in Europe/Madrid, America/Panama and America/Costa_Rica, and the same calendar is read from all three.\n\nEvery requested day is present in the response, with an empty `slots` list when there is nothing to offer: \"closed that day\" and \"outside the range you asked for\" are different answers.\n\nRestricting by staff is optional. `employeeId` / `employeeIds` are the canonical names; `trabajadorId` / `trabajadorIds` and the GHL spellings `userId` / `userIds` are accepted as aliases and merged into one set.\n\nThe range is capped at 31 days.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "scheduling", "calendars", ":id", "free-slots" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) First day of the range, inclusive, read in `timezone` (YYYY-MM-DD)", "type": "text/plain" }, "key": "startDate", "value": "" }, { "disabled": false, "description": { "content": "Last day of the range, inclusive, read in `timezone` (YYYY-MM-DD). Defaults to `startDate`.", "type": "text/plain" }, "key": "endDate", "value": "" }, { "disabled": false, "description": { "content": "(Required) IANA timezone the grid is computed in. Mandatory.", "type": "text/plain" }, "key": "timezone", "value": "" }, { "disabled": false, "description": { "content": "Restrict the answer to one employee (GHL `userId`)", "type": "text/plain" }, "key": "employeeId", "value": "" }, { "disabled": false, "description": { "content": "Restrict the answer to several employees (GHL `userIds`)", "type": "text/plain" }, "key": "employeeIds", "value": "" }, { "disabled": false, "description": { "content": "Restrict the answer to several employees (GHL `userIds`)", "type": "text/plain" }, "key": "employeeIds", "value": "" }, { "disabled": false, "description": { "content": "Alias of `employeeId`", "type": "text/plain" }, "key": "trabajadorId", "value": "" }, { "disabled": false, "description": { "content": "Alias of `employeeIds`", "type": "text/plain" }, "key": "trabajadorIds", "value": "" }, { "disabled": false, "description": { "content": "Alias of `employeeIds`", "type": "text/plain" }, "key": "trabajadorIds", "value": "" }, { "disabled": false, "description": { "content": "GHL alias of `employeeId`", "type": "text/plain" }, "key": "userId", "value": "" }, { "disabled": false, "description": { "content": "GHL alias of `employeeIds`", "type": "text/plain" }, "key": "userIds", "value": "" }, { "disabled": false, "description": { "content": "GHL alias of `employeeIds`", "type": "text/plain" }, "key": "userIds", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "dd9b0257-3ab8-420a-bd36-afe941f104bc", "name": "Availability for the requested range", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", ":id", "free-slots" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) First day of the range, inclusive, read in `timezone` (YYYY-MM-DD)", "type": "text/plain" }, "key": "startDate", "value": "" }, { "disabled": false, "description": { "content": "Last day of the range, inclusive, read in `timezone` (YYYY-MM-DD). Defaults to `startDate`.", "type": "text/plain" }, "key": "endDate", "value": "" }, { "disabled": false, "description": { "content": "(Required) IANA timezone the grid is computed in. Mandatory.", "type": "text/plain" }, "key": "timezone", "value": "" }, { "disabled": false, "description": { "content": "Restrict the answer to one employee (GHL `userId`)", "type": "text/plain" }, "key": "employeeId", "value": "" }, { "disabled": false, "description": { "content": "Restrict the answer to several employees (GHL `userIds`)", "type": "text/plain" }, "key": "employeeIds", "value": "" }, { "disabled": false, "description": { "content": "Alias of `employeeId`", "type": "text/plain" }, "key": "trabajadorId", "value": "" }, { "disabled": false, "description": { "content": "Alias of `employeeIds`", "type": "text/plain" }, "key": "trabajadorIds", "value": "" }, { "disabled": false, "description": { "content": "GHL alias of `employeeId`", "type": "text/plain" }, "key": "userId", "value": "" }, { "disabled": false, "description": { "content": "GHL alias of `employeeIds`", "type": "text/plain" }, "key": "userIds", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"calendarId\": \"\",\n \"timezone\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"employeeIds\": [\n \"\",\n \"\"\n ],\n \"days\": [\n {\n \"date\": \"\",\n \"slots\": [\n {\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"seatsAvailable\": \"\",\n \"eligibleEmployeeIds\": [\n \"\",\n \"\"\n ],\n \"assignedEmployeeId\": \"\"\n },\n {\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"seatsAvailable\": \"\",\n \"eligibleEmployeeIds\": [\n \"\",\n \"\"\n ],\n \"assignedEmployeeId\": \"\"\n }\n ]\n },\n {\n \"date\": \"\",\n \"slots\": [\n {\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"seatsAvailable\": \"\",\n \"eligibleEmployeeIds\": [\n \"\",\n \"\"\n ],\n \"assignedEmployeeId\": \"\"\n },\n {\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"seatsAvailable\": \"\",\n \"eligibleEmployeeIds\": [\n \"\",\n \"\"\n ],\n \"assignedEmployeeId\": \"\"\n }\n ]\n }\n ],\n \"totalSlots\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bc29b85b-848e-4fed-84d3-49b64758ffe7", "name": "Missing or unparseable timezone / dates, inverted range, or a range longer than 31 days", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", ":id", "free-slots" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) First day of the range, inclusive, read in `timezone` (YYYY-MM-DD)", "type": "text/plain" }, "key": "startDate", "value": "" }, { "disabled": false, "description": { "content": "Last day of the range, inclusive, read in `timezone` (YYYY-MM-DD). Defaults to `startDate`.", "type": "text/plain" }, "key": "endDate", "value": "" }, { "disabled": false, "description": { "content": "(Required) IANA timezone the grid is computed in. Mandatory.", "type": "text/plain" }, "key": "timezone", "value": "" }, { "disabled": false, "description": { "content": "Restrict the answer to one employee (GHL `userId`)", "type": "text/plain" }, "key": "employeeId", "value": "" }, { "disabled": false, "description": { "content": "Restrict the answer to several employees (GHL `userIds`)", "type": "text/plain" }, "key": "employeeIds", "value": "" }, { "disabled": false, "description": { "content": "Alias of `employeeId`", "type": "text/plain" }, "key": "trabajadorId", "value": "" }, { "disabled": false, "description": { "content": "Alias of `employeeIds`", "type": "text/plain" }, "key": "trabajadorIds", "value": "" }, { "disabled": false, "description": { "content": "GHL alias of `employeeId`", "type": "text/plain" }, "key": "userId", "value": "" }, { "disabled": false, "description": { "content": "GHL alias of `employeeIds`", "type": "text/plain" }, "key": "userIds", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d6151ccf-af6c-43fe-bf0a-280b741e9aa8", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", ":id", "free-slots" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) First day of the range, inclusive, read in `timezone` (YYYY-MM-DD)", "type": "text/plain" }, "key": "startDate", "value": "" }, { "disabled": false, "description": { "content": "Last day of the range, inclusive, read in `timezone` (YYYY-MM-DD). Defaults to `startDate`.", "type": "text/plain" }, "key": "endDate", "value": "" }, { "disabled": false, "description": { "content": "(Required) IANA timezone the grid is computed in. Mandatory.", "type": "text/plain" }, "key": "timezone", "value": "" }, { "disabled": false, "description": { "content": "Restrict the answer to one employee (GHL `userId`)", "type": "text/plain" }, "key": "employeeId", "value": "" }, { "disabled": false, "description": { "content": "Restrict the answer to several employees (GHL `userIds`)", "type": "text/plain" }, "key": "employeeIds", "value": "" }, { "disabled": false, "description": { "content": "Alias of `employeeId`", "type": "text/plain" }, "key": "trabajadorId", "value": "" }, { "disabled": false, "description": { "content": "Alias of `employeeIds`", "type": "text/plain" }, "key": "trabajadorIds", "value": "" }, { "disabled": false, "description": { "content": "GHL alias of `employeeId`", "type": "text/plain" }, "key": "userId", "value": "" }, { "disabled": false, "description": { "content": "GHL alias of `employeeIds`", "type": "text/plain" }, "key": "userIds", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "befaefef-e4f4-4976-a435-08b70b946319", "name": "Authenticated user is missing the `VER_CALENDARIOUI` permission", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", ":id", "free-slots" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) First day of the range, inclusive, read in `timezone` (YYYY-MM-DD)", "type": "text/plain" }, "key": "startDate", "value": "" }, { "disabled": false, "description": { "content": "Last day of the range, inclusive, read in `timezone` (YYYY-MM-DD). Defaults to `startDate`.", "type": "text/plain" }, "key": "endDate", "value": "" }, { "disabled": false, "description": { "content": "(Required) IANA timezone the grid is computed in. Mandatory.", "type": "text/plain" }, "key": "timezone", "value": "" }, { "disabled": false, "description": { "content": "Restrict the answer to one employee (GHL `userId`)", "type": "text/plain" }, "key": "employeeId", "value": "" }, { "disabled": false, "description": { "content": "Restrict the answer to several employees (GHL `userIds`)", "type": "text/plain" }, "key": "employeeIds", "value": "" }, { "disabled": false, "description": { "content": "Alias of `employeeId`", "type": "text/plain" }, "key": "trabajadorId", "value": "" }, { "disabled": false, "description": { "content": "Alias of `employeeIds`", "type": "text/plain" }, "key": "trabajadorIds", "value": "" }, { "disabled": false, "description": { "content": "GHL alias of `employeeId`", "type": "text/plain" }, "key": "userId", "value": "" }, { "disabled": false, "description": { "content": "GHL alias of `employeeIds`", "type": "text/plain" }, "key": "userIds", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "62453c7f-53ee-47cf-9ad3-2d2597d12386", "name": "Calendar not found or outside the caller's company scope", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", ":id", "free-slots" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) First day of the range, inclusive, read in `timezone` (YYYY-MM-DD)", "type": "text/plain" }, "key": "startDate", "value": "" }, { "disabled": false, "description": { "content": "Last day of the range, inclusive, read in `timezone` (YYYY-MM-DD). Defaults to `startDate`.", "type": "text/plain" }, "key": "endDate", "value": "" }, { "disabled": false, "description": { "content": "(Required) IANA timezone the grid is computed in. Mandatory.", "type": "text/plain" }, "key": "timezone", "value": "" }, { "disabled": false, "description": { "content": "Restrict the answer to one employee (GHL `userId`)", "type": "text/plain" }, "key": "employeeId", "value": "" }, { "disabled": false, "description": { "content": "Restrict the answer to several employees (GHL `userIds`)", "type": "text/plain" }, "key": "employeeIds", "value": "" }, { "disabled": false, "description": { "content": "Alias of `employeeId`", "type": "text/plain" }, "key": "trabajadorId", "value": "" }, { "disabled": false, "description": { "content": "Alias of `employeeIds`", "type": "text/plain" }, "key": "trabajadorIds", "value": "" }, { "disabled": false, "description": { "content": "GHL alias of `employeeId`", "type": "text/plain" }, "key": "userId", "value": "" }, { "disabled": false, "description": { "content": "GHL alias of `employeeIds`", "type": "text/plain" }, "key": "userIds", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "12af0901-526b-4796-8263-22ac16e83b3c", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", ":id", "free-slots" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) First day of the range, inclusive, read in `timezone` (YYYY-MM-DD)", "type": "text/plain" }, "key": "startDate", "value": "" }, { "disabled": false, "description": { "content": "Last day of the range, inclusive, read in `timezone` (YYYY-MM-DD). Defaults to `startDate`.", "type": "text/plain" }, "key": "endDate", "value": "" }, { "disabled": false, "description": { "content": "(Required) IANA timezone the grid is computed in. Mandatory.", "type": "text/plain" }, "key": "timezone", "value": "" }, { "disabled": false, "description": { "content": "Restrict the answer to one employee (GHL `userId`)", "type": "text/plain" }, "key": "employeeId", "value": "" }, { "disabled": false, "description": { "content": "Restrict the answer to several employees (GHL `userIds`)", "type": "text/plain" }, "key": "employeeIds", "value": "" }, { "disabled": false, "description": { "content": "Alias of `employeeId`", "type": "text/plain" }, "key": "trabajadorId", "value": "" }, { "disabled": false, "description": { "content": "Alias of `employeeIds`", "type": "text/plain" }, "key": "trabajadorIds", "value": "" }, { "disabled": false, "description": { "content": "GHL alias of `employeeId`", "type": "text/plain" }, "key": "userId", "value": "" }, { "disabled": false, "description": { "content": "GHL alias of `employeeIds`", "type": "text/plain" }, "key": "userIds", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "schedules", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "b76d92c4-0b67-47ec-9293-d4b9dda08837", "name": "Get staff schedule by ID", "request": { "name": "Get staff schedule by ID", "description": {}, "url": { "path": [ "api", "v2", "scheduling", "calendars", "schedules", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Staff schedule ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "457b355f-840f-4e9b-90a3-c369ea4d2d63", "name": "Staff schedule found", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "schedules", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Staff schedule ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"active\": \"\",\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"timeZone\": \"\",\n \"calendarIds\": [\n \"\",\n \"\"\n ],\n \"rules\": [\n {\n \"type\": \"date\",\n \"day\": \"monday\",\n \"date\": \"\",\n \"intervals\": [\n {\n \"from\": \"\",\n \"to\": \"\"\n },\n {\n \"from\": \"\",\n \"to\": \"\"\n }\n ]\n },\n {\n \"type\": \"date\",\n \"day\": \"thursday\",\n \"date\": \"\",\n \"intervals\": [\n {\n \"from\": \"\",\n \"to\": \"\"\n },\n {\n \"from\": \"\",\n \"to\": \"\"\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2145963b-6a18-4fae-9bd2-9031171a4394", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "schedules", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Staff schedule ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2b8b8e01-8c64-4cad-966e-28f85869c86d", "name": "Authenticated user is missing the `VER_HORARIOSTRABAJADOR` permission", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "schedules", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Staff schedule ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "39d2c81e-2114-4c8d-b9b5-c63fd8764a06", "name": "Staff schedule not found", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "schedules", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Staff schedule ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "09008f69-b849-4937-aa92-e59a133f78ba", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "schedules", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Staff schedule ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "780ffa8f-6c0e-423f-afe7-fd1caf922319", "name": "Update staff schedule", "request": { "name": "Update staff schedule", "description": {}, "url": { "path": [ "api", "v2", "scheduling", "calendars", "schedules", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Staff schedule ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"active\": \"\",\n \"employeeId\": \"\",\n \"timeZone\": \"\",\n \"calendarIds\": [\n \"\",\n \"\"\n ],\n \"rules\": [\n {\n \"type\": \"wday\",\n \"day\": \"saturday\",\n \"date\": \"\",\n \"intervals\": [\n {\n \"from\": \"\",\n \"to\": \"\"\n },\n {\n \"from\": \"\",\n \"to\": \"\"\n }\n ]\n },\n {\n \"type\": \"wday\",\n \"day\": \"sunday\",\n \"date\": \"\",\n \"intervals\": [\n {\n \"from\": \"\",\n \"to\": \"\"\n },\n {\n \"from\": \"\",\n \"to\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "30ec823c-7c80-4ed5-b7d0-efb5bff439fe", "name": "Staff schedule updated", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "schedules", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Staff schedule ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"active\": \"\",\n \"employeeId\": \"\",\n \"timeZone\": \"\",\n \"calendarIds\": [\n \"\",\n \"\"\n ],\n \"rules\": [\n {\n \"type\": \"wday\",\n \"day\": \"saturday\",\n \"date\": \"\",\n \"intervals\": [\n {\n \"from\": \"\",\n \"to\": \"\"\n },\n {\n \"from\": \"\",\n \"to\": \"\"\n }\n ]\n },\n {\n \"type\": \"wday\",\n \"day\": \"sunday\",\n \"date\": \"\",\n \"intervals\": [\n {\n \"from\": \"\",\n \"to\": \"\"\n },\n {\n \"from\": \"\",\n \"to\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"active\": \"\",\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"timeZone\": \"\",\n \"calendarIds\": [\n \"\",\n \"\"\n ],\n \"rules\": [\n {\n \"type\": \"date\",\n \"day\": \"monday\",\n \"date\": \"\",\n \"intervals\": [\n {\n \"from\": \"\",\n \"to\": \"\"\n },\n {\n \"from\": \"\",\n \"to\": \"\"\n }\n ]\n },\n {\n \"type\": \"date\",\n \"day\": \"thursday\",\n \"date\": \"\",\n \"intervals\": [\n {\n \"from\": \"\",\n \"to\": \"\"\n },\n {\n \"from\": \"\",\n \"to\": \"\"\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1b5641fa-5d99-4584-9fce-da8080f51586", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "schedules", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Staff schedule ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"active\": \"\",\n \"employeeId\": \"\",\n \"timeZone\": \"\",\n \"calendarIds\": [\n \"\",\n \"\"\n ],\n \"rules\": [\n {\n \"type\": \"wday\",\n \"day\": \"saturday\",\n \"date\": \"\",\n \"intervals\": [\n {\n \"from\": \"\",\n \"to\": \"\"\n },\n {\n \"from\": \"\",\n \"to\": \"\"\n }\n ]\n },\n {\n \"type\": \"wday\",\n \"day\": \"sunday\",\n \"date\": \"\",\n \"intervals\": [\n {\n \"from\": \"\",\n \"to\": \"\"\n },\n {\n \"from\": \"\",\n \"to\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "64398119-1caa-4411-b342-3d2edce91759", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "schedules", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Staff schedule ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"active\": \"\",\n \"employeeId\": \"\",\n \"timeZone\": \"\",\n \"calendarIds\": [\n \"\",\n \"\"\n ],\n \"rules\": [\n {\n \"type\": \"wday\",\n \"day\": \"saturday\",\n \"date\": \"\",\n \"intervals\": [\n {\n \"from\": \"\",\n \"to\": \"\"\n },\n {\n \"from\": \"\",\n \"to\": \"\"\n }\n ]\n },\n {\n \"type\": \"wday\",\n \"day\": \"sunday\",\n \"date\": \"\",\n \"intervals\": [\n {\n \"from\": \"\",\n \"to\": \"\"\n },\n {\n \"from\": \"\",\n \"to\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "99c46a76-18d1-422f-b667-4064cfbff3ff", "name": "Authenticated user is missing the `EDITAR_HORARIOSTRABAJADOR` permission", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "schedules", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Staff schedule ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"active\": \"\",\n \"employeeId\": \"\",\n \"timeZone\": \"\",\n \"calendarIds\": [\n \"\",\n \"\"\n ],\n \"rules\": [\n {\n \"type\": \"wday\",\n \"day\": \"saturday\",\n \"date\": \"\",\n \"intervals\": [\n {\n \"from\": \"\",\n \"to\": \"\"\n },\n {\n \"from\": \"\",\n \"to\": \"\"\n }\n ]\n },\n {\n \"type\": \"wday\",\n \"day\": \"sunday\",\n \"date\": \"\",\n \"intervals\": [\n {\n \"from\": \"\",\n \"to\": \"\"\n },\n {\n \"from\": \"\",\n \"to\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "43d2913c-9076-46b0-9ce4-377defde7306", "name": "Staff schedule not found", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "schedules", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Staff schedule ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"active\": \"\",\n \"employeeId\": \"\",\n \"timeZone\": \"\",\n \"calendarIds\": [\n \"\",\n \"\"\n ],\n \"rules\": [\n {\n \"type\": \"wday\",\n \"day\": \"saturday\",\n \"date\": \"\",\n \"intervals\": [\n {\n \"from\": \"\",\n \"to\": \"\"\n },\n {\n \"from\": \"\",\n \"to\": \"\"\n }\n ]\n },\n {\n \"type\": \"wday\",\n \"day\": \"sunday\",\n \"date\": \"\",\n \"intervals\": [\n {\n \"from\": \"\",\n \"to\": \"\"\n },\n {\n \"from\": \"\",\n \"to\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "859f13e2-d0e8-4c20-84e8-53e78894f865", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "schedules", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Staff schedule ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"active\": \"\",\n \"employeeId\": \"\",\n \"timeZone\": \"\",\n \"calendarIds\": [\n \"\",\n \"\"\n ],\n \"rules\": [\n {\n \"type\": \"wday\",\n \"day\": \"saturday\",\n \"date\": \"\",\n \"intervals\": [\n {\n \"from\": \"\",\n \"to\": \"\"\n },\n {\n \"from\": \"\",\n \"to\": \"\"\n }\n ]\n },\n {\n \"type\": \"wday\",\n \"day\": \"sunday\",\n \"date\": \"\",\n \"intervals\": [\n {\n \"from\": \"\",\n \"to\": \"\"\n },\n {\n \"from\": \"\",\n \"to\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b5c32d35-7fe2-4f60-b893-fbe0d26d3540", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "schedules", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Staff schedule ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"active\": \"\",\n \"employeeId\": \"\",\n \"timeZone\": \"\",\n \"calendarIds\": [\n \"\",\n \"\"\n ],\n \"rules\": [\n {\n \"type\": \"wday\",\n \"day\": \"saturday\",\n \"date\": \"\",\n \"intervals\": [\n {\n \"from\": \"\",\n \"to\": \"\"\n },\n {\n \"from\": \"\",\n \"to\": \"\"\n }\n ]\n },\n {\n \"type\": \"wday\",\n \"day\": \"sunday\",\n \"date\": \"\",\n \"intervals\": [\n {\n \"from\": \"\",\n \"to\": \"\"\n },\n {\n \"from\": \"\",\n \"to\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9b14664e-5d25-4eec-a177-d3d9a3d626cc", "name": "Delete staff schedule", "request": { "name": "Delete staff schedule", "description": {}, "url": { "path": [ "api", "v2", "scheduling", "calendars", "schedules", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Staff schedule ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "f8c39193-8b2e-4f4f-8940-ad7335704b2d", "name": "Staff schedule deleted", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "schedules", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Staff schedule ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8a82e401-18c6-4759-9a6b-4f15bec8bc8f", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "schedules", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Staff schedule ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5df2e481-1393-49d8-9982-abf57edc883d", "name": "Authenticated user is missing the `BORRAR_HORARIOSTRABAJADOR` permission", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "schedules", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Staff schedule ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4045a0eb-e3ef-4984-afd7-8aa3f4a64012", "name": "Staff schedule not found", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "schedules", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Staff schedule ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fef2a4d1-2c5d-4583-bf6d-fdf66ee2de5c", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "schedules", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Staff schedule ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "260de516-6a85-482b-a1f5-075cddcc0554", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "schedules", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Staff schedule ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d3d93365-a306-4063-a7cc-99b68ba59d35", "name": "Merge-patch staff schedule", "request": { "name": "Merge-patch staff schedule", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "scheduling", "calendars", "schedules", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Staff schedule ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "92e2edd2-c6fb-4d43-86dc-02645bd11123", "name": "Staff schedule patched", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "schedules", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Staff schedule ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"active\": \"\",\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"timeZone\": \"\",\n \"calendarIds\": [\n \"\",\n \"\"\n ],\n \"rules\": [\n {\n \"type\": \"date\",\n \"day\": \"monday\",\n \"date\": \"\",\n \"intervals\": [\n {\n \"from\": \"\",\n \"to\": \"\"\n },\n {\n \"from\": \"\",\n \"to\": \"\"\n }\n ]\n },\n {\n \"type\": \"date\",\n \"day\": \"thursday\",\n \"date\": \"\",\n \"intervals\": [\n {\n \"from\": \"\",\n \"to\": \"\"\n },\n {\n \"from\": \"\",\n \"to\": \"\"\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a169869d-36c4-4601-95e0-0c4e3ea57992", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "schedules", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Staff schedule ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6be5045c-f52b-4297-8351-036d8846c5f3", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "schedules", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Staff schedule ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "86e819d5-0fee-4d1d-a18b-e67b9fcdb53e", "name": "Authenticated user is missing the `EDITAR_HORARIOSTRABAJADOR` permission", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "schedules", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Staff schedule ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cc9da9e8-c299-46a8-a341-f761fcff9ba6", "name": "Staff schedule not found", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "schedules", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Staff schedule ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5671b568-fd20-4933-90d4-86149683c705", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "schedules", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Staff schedule ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "85c06e3f-e4d8-4be2-956c-b1d37b1cea4d", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "schedules", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Staff schedule ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "a7bde21f-dd36-44b3-bab0-fc7873cb6cfa", "name": "List staff schedules", "request": { "name": "List staff schedules", "description": {}, "url": { "path": [ "api", "v2", "scheduling", "calendars", "schedules" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "ab1965e6-4fcd-4c64-8d1e-27aa3ebac370", "name": "Page of staff schedules", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "schedules" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "89172e95-cf8b-450d-a203-d861e1e49f7e", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "schedules" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8162ee18-7e04-4f72-8224-163cf71a4bdf", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "schedules" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "29215226-0903-4a22-a060-2bbd03160431", "name": "Authenticated user is missing the `VER_HORARIOSTRABAJADOR` permission", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "schedules" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cc0b969f-e08b-4690-88e9-d55c896a9fe6", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "schedules" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b0fb78f0-f6e8-40ad-a52d-9e31a3272121", "name": "Create staff schedule", "request": { "name": "Create staff schedule", "description": {}, "url": { "path": [ "api", "v2", "scheduling", "calendars", "schedules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"active\": \"\",\n \"employeeId\": \"\",\n \"timeZone\": \"\",\n \"calendarIds\": [\n \"\",\n \"\"\n ],\n \"rules\": [\n {\n \"type\": \"wday\",\n \"day\": \"saturday\",\n \"date\": \"\",\n \"intervals\": [\n {\n \"from\": \"\",\n \"to\": \"\"\n },\n {\n \"from\": \"\",\n \"to\": \"\"\n }\n ]\n },\n {\n \"type\": \"wday\",\n \"day\": \"sunday\",\n \"date\": \"\",\n \"intervals\": [\n {\n \"from\": \"\",\n \"to\": \"\"\n },\n {\n \"from\": \"\",\n \"to\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "542b2977-247b-4213-b0ab-0873ee8803ff", "name": "Staff schedule created", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "schedules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"active\": \"\",\n \"employeeId\": \"\",\n \"timeZone\": \"\",\n \"calendarIds\": [\n \"\",\n \"\"\n ],\n \"rules\": [\n {\n \"type\": \"wday\",\n \"day\": \"saturday\",\n \"date\": \"\",\n \"intervals\": [\n {\n \"from\": \"\",\n \"to\": \"\"\n },\n {\n \"from\": \"\",\n \"to\": \"\"\n }\n ]\n },\n {\n \"type\": \"wday\",\n \"day\": \"sunday\",\n \"date\": \"\",\n \"intervals\": [\n {\n \"from\": \"\",\n \"to\": \"\"\n },\n {\n \"from\": \"\",\n \"to\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"active\": \"\",\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"timeZone\": \"\",\n \"calendarIds\": [\n \"\",\n \"\"\n ],\n \"rules\": [\n {\n \"type\": \"date\",\n \"day\": \"monday\",\n \"date\": \"\",\n \"intervals\": [\n {\n \"from\": \"\",\n \"to\": \"\"\n },\n {\n \"from\": \"\",\n \"to\": \"\"\n }\n ]\n },\n {\n \"type\": \"date\",\n \"day\": \"thursday\",\n \"date\": \"\",\n \"intervals\": [\n {\n \"from\": \"\",\n \"to\": \"\"\n },\n {\n \"from\": \"\",\n \"to\": \"\"\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a781284d-2494-4414-adaa-d76f2a521f9c", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "schedules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"active\": \"\",\n \"employeeId\": \"\",\n \"timeZone\": \"\",\n \"calendarIds\": [\n \"\",\n \"\"\n ],\n \"rules\": [\n {\n \"type\": \"wday\",\n \"day\": \"saturday\",\n \"date\": \"\",\n \"intervals\": [\n {\n \"from\": \"\",\n \"to\": \"\"\n },\n {\n \"from\": \"\",\n \"to\": \"\"\n }\n ]\n },\n {\n \"type\": \"wday\",\n \"day\": \"sunday\",\n \"date\": \"\",\n \"intervals\": [\n {\n \"from\": \"\",\n \"to\": \"\"\n },\n {\n \"from\": \"\",\n \"to\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "10a7bc2a-66b7-470d-b0db-d0ab3d2ac8df", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "schedules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"active\": \"\",\n \"employeeId\": \"\",\n \"timeZone\": \"\",\n \"calendarIds\": [\n \"\",\n \"\"\n ],\n \"rules\": [\n {\n \"type\": \"wday\",\n \"day\": \"saturday\",\n \"date\": \"\",\n \"intervals\": [\n {\n \"from\": \"\",\n \"to\": \"\"\n },\n {\n \"from\": \"\",\n \"to\": \"\"\n }\n ]\n },\n {\n \"type\": \"wday\",\n \"day\": \"sunday\",\n \"date\": \"\",\n \"intervals\": [\n {\n \"from\": \"\",\n \"to\": \"\"\n },\n {\n \"from\": \"\",\n \"to\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d99973e8-b206-4d8e-9808-a6a416a5e05a", "name": "Authenticated user is missing the `CREAR_HORARIOSTRABAJADOR` permission", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "schedules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"active\": \"\",\n \"employeeId\": \"\",\n \"timeZone\": \"\",\n \"calendarIds\": [\n \"\",\n \"\"\n ],\n \"rules\": [\n {\n \"type\": \"wday\",\n \"day\": \"saturday\",\n \"date\": \"\",\n \"intervals\": [\n {\n \"from\": \"\",\n \"to\": \"\"\n },\n {\n \"from\": \"\",\n \"to\": \"\"\n }\n ]\n },\n {\n \"type\": \"wday\",\n \"day\": \"sunday\",\n \"date\": \"\",\n \"intervals\": [\n {\n \"from\": \"\",\n \"to\": \"\"\n },\n {\n \"from\": \"\",\n \"to\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "604c4600-baa4-46d5-8150-f8052b92dcec", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "schedules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"active\": \"\",\n \"employeeId\": \"\",\n \"timeZone\": \"\",\n \"calendarIds\": [\n \"\",\n \"\"\n ],\n \"rules\": [\n {\n \"type\": \"wday\",\n \"day\": \"saturday\",\n \"date\": \"\",\n \"intervals\": [\n {\n \"from\": \"\",\n \"to\": \"\"\n },\n {\n \"from\": \"\",\n \"to\": \"\"\n }\n ]\n },\n {\n \"type\": \"wday\",\n \"day\": \"sunday\",\n \"date\": \"\",\n \"intervals\": [\n {\n \"from\": \"\",\n \"to\": \"\"\n },\n {\n \"from\": \"\",\n \"to\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "resources", "description": "", "item": [ { "name": "rooms", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "eacd92fa-a274-49bb-834e-8500841a12e2", "name": "Get calendar room by ID", "request": { "name": "Get calendar room by ID", "description": {}, "url": { "path": [ "api", "v2", "scheduling", "calendars", "resources", "rooms", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "5a1549fd-2ebe-4c0a-bcca-7a137283164e", "name": "Calendar room found", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "resources", "rooms", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"resourceType\": \"ROOM\",\n \"quantity\": \"\",\n \"capacity\": \"\",\n \"outOfService\": \"\",\n \"calendarIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\",\n \"companyName\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3c2cad0e-c76d-4b8c-862d-18b7c4f1b835", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "resources", "rooms", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b5dd9a1d-79f6-4f61-82f5-45bc6467c88f", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "resources", "rooms", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f670cc98-ad96-449e-aad9-bd589c8de5bc", "name": "Update calendar room", "request": { "name": "Update calendar room", "description": {}, "url": { "path": [ "api", "v2", "scheduling", "calendars", "resources", "rooms", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"resourceType\": \"EQUIPMENT\",\n \"quantity\": \"\",\n \"capacity\": \"\",\n \"outOfService\": \"\",\n \"calendarIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "d262c136-bae6-4d17-afe6-49edf403a68a", "name": "Calendar room updated", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "resources", "rooms", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"resourceType\": \"EQUIPMENT\",\n \"quantity\": \"\",\n \"capacity\": \"\",\n \"outOfService\": \"\",\n \"calendarIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"resourceType\": \"ROOM\",\n \"quantity\": \"\",\n \"capacity\": \"\",\n \"outOfService\": \"\",\n \"calendarIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\",\n \"companyName\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "04d9f48f-f1e2-4686-8ccc-b40edab75a9e", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "resources", "rooms", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"resourceType\": \"EQUIPMENT\",\n \"quantity\": \"\",\n \"capacity\": \"\",\n \"outOfService\": \"\",\n \"calendarIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6a7a37d4-8b30-475b-9bf0-aafd51ac208b", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "resources", "rooms", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"resourceType\": \"EQUIPMENT\",\n \"quantity\": \"\",\n \"capacity\": \"\",\n \"outOfService\": \"\",\n \"calendarIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6db2a145-11c8-4bc8-a1c1-e685a808ceac", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "resources", "rooms", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"resourceType\": \"EQUIPMENT\",\n \"quantity\": \"\",\n \"capacity\": \"\",\n \"outOfService\": \"\",\n \"calendarIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "064c9693-afeb-486d-b108-38dcb4dca594", "name": "Delete calendar room", "request": { "name": "Delete calendar room", "description": {}, "url": { "path": [ "api", "v2", "scheduling", "calendars", "resources", "rooms", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "10e60b2f-7b26-4f35-aa25-8a29e0c67a8a", "name": "Calendar room deleted", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "resources", "rooms", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8b030259-43fb-4216-a508-f9583cd93698", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "resources", "rooms", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1863ffbe-50fc-4d58-8186-bbc08b782a38", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "resources", "rooms", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bc919293-12de-4054-84cf-8d3bada63c6d", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "resources", "rooms", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d91a4a1f-e0eb-4d76-ba97-65730ec0d6b5", "name": "Merge-patch calendar room", "request": { "name": "Merge-patch calendar room", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "scheduling", "calendars", "resources", "rooms", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "b3d22ea7-b849-459f-a012-e8c2c928586a", "name": "Calendar room patched", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "resources", "rooms", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"resourceType\": \"ROOM\",\n \"quantity\": \"\",\n \"capacity\": \"\",\n \"outOfService\": \"\",\n \"calendarIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\",\n \"companyName\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8cf2229f-64c1-47f4-9e4f-93df7d7fabcd", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "resources", "rooms", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4ee7bd66-174c-45b4-b034-b45193b67a79", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "resources", "rooms", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8669bef6-21ab-46f2-8a8e-069d1786fc25", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "resources", "rooms", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "9259306c-d092-4299-a708-1a7fdfaa5025", "name": "List calendar rooms", "request": { "name": "List calendar rooms", "description": {}, "url": { "path": [ "api", "v2", "scheduling", "calendars", "resources", "rooms" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "6cffb38f-fcc5-4704-bc46-a56b09b1743f", "name": "Page of calendar rooms", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "resources", "rooms" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b5ff0872-3aec-40b1-8b90-13a0707b451d", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "resources", "rooms" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "95b09702-f2ff-4328-82ae-189e4895518d", "name": "Authenticated user is missing the `VER_CALENDARIORECURSOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "resources", "rooms" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9594cff8-b379-4b54-a5bd-5bd7ddce4a14", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "resources", "rooms" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f07e0459-e8d8-435d-bbe6-e4b8ac073fcc", "name": "Create calendar room", "request": { "name": "Create calendar room", "description": {}, "url": { "path": [ "api", "v2", "scheduling", "calendars", "resources", "rooms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"resourceType\": \"EQUIPMENT\",\n \"quantity\": \"\",\n \"capacity\": \"\",\n \"outOfService\": \"\",\n \"calendarIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "8eba01bc-fe0c-432f-9271-a6c0a04f309d", "name": "Calendar room created", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "resources", "rooms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"resourceType\": \"EQUIPMENT\",\n \"quantity\": \"\",\n \"capacity\": \"\",\n \"outOfService\": \"\",\n \"calendarIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"resourceType\": \"ROOM\",\n \"quantity\": \"\",\n \"capacity\": \"\",\n \"outOfService\": \"\",\n \"calendarIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\",\n \"companyName\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cd62672d-4f61-43f7-ad44-dfe2e1bdf123", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "resources", "rooms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"resourceType\": \"EQUIPMENT\",\n \"quantity\": \"\",\n \"capacity\": \"\",\n \"outOfService\": \"\",\n \"calendarIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "07e0afc4-de45-4d67-9a1f-34b318cf23ff", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "resources", "rooms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"resourceType\": \"EQUIPMENT\",\n \"quantity\": \"\",\n \"capacity\": \"\",\n \"outOfService\": \"\",\n \"calendarIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "equipments", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "c7ef0161-0454-41e5-9d4f-f6a75071af4a", "name": "Get calendar equipment by ID", "request": { "name": "Get calendar equipment by ID", "description": {}, "url": { "path": [ "api", "v2", "scheduling", "calendars", "resources", "equipments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "bafc68b6-83d5-49fd-99e8-f9056017713e", "name": "Calendar equipment found", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "resources", "equipments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"resourceType\": \"ROOM\",\n \"quantity\": \"\",\n \"capacity\": \"\",\n \"outOfService\": \"\",\n \"calendarIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\",\n \"companyName\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0b38e656-2ecf-437a-89ef-3f6a0f67611a", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "resources", "equipments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "99e6e4e6-82b4-426e-ad6d-f319d155f934", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "resources", "equipments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ae91e007-0e9c-4e0f-9e4a-29d7485772d3", "name": "Update calendar equipment", "request": { "name": "Update calendar equipment", "description": {}, "url": { "path": [ "api", "v2", "scheduling", "calendars", "resources", "equipments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"resourceType\": \"EQUIPMENT\",\n \"quantity\": \"\",\n \"capacity\": \"\",\n \"outOfService\": \"\",\n \"calendarIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "701a4ba5-71e1-4fe3-829f-a173af5a5dc5", "name": "Calendar equipment updated", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "resources", "equipments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"resourceType\": \"EQUIPMENT\",\n \"quantity\": \"\",\n \"capacity\": \"\",\n \"outOfService\": \"\",\n \"calendarIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"resourceType\": \"ROOM\",\n \"quantity\": \"\",\n \"capacity\": \"\",\n \"outOfService\": \"\",\n \"calendarIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\",\n \"companyName\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "217b8ccb-9340-403c-9198-23e254ff6755", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "resources", "equipments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"resourceType\": \"EQUIPMENT\",\n \"quantity\": \"\",\n \"capacity\": \"\",\n \"outOfService\": \"\",\n \"calendarIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "28dfd9ee-e21c-406a-9900-4b8d91cad6b8", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "resources", "equipments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"resourceType\": \"EQUIPMENT\",\n \"quantity\": \"\",\n \"capacity\": \"\",\n \"outOfService\": \"\",\n \"calendarIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c28ed1b3-40d5-41fb-9f5d-e5220d0d6af7", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "resources", "equipments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"resourceType\": \"EQUIPMENT\",\n \"quantity\": \"\",\n \"capacity\": \"\",\n \"outOfService\": \"\",\n \"calendarIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "26fc785d-1c88-4bde-94b1-4615336cfdb7", "name": "Delete calendar equipment", "request": { "name": "Delete calendar equipment", "description": {}, "url": { "path": [ "api", "v2", "scheduling", "calendars", "resources", "equipments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "28fd753c-e494-41ef-84e0-d6442bd4b8c6", "name": "Calendar equipment deleted", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "resources", "equipments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ba03e244-e04f-4176-aa56-015a54fa2675", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "resources", "equipments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d8b00b78-2c6c-4a46-bbaf-de38babbd539", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "resources", "equipments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "504c27dc-2158-4860-b3df-cae5d069be1e", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "resources", "equipments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "665e8e9d-e5ba-467a-abd3-d424e1a63400", "name": "Merge-patch calendar equipment", "request": { "name": "Merge-patch calendar equipment", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "scheduling", "calendars", "resources", "equipments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "d1f1c4f0-2502-4344-a1f4-d21bfadd8cc9", "name": "Calendar equipment patched", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "resources", "equipments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"resourceType\": \"ROOM\",\n \"quantity\": \"\",\n \"capacity\": \"\",\n \"outOfService\": \"\",\n \"calendarIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\",\n \"companyName\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "59a7af19-a232-4984-b880-d316047a618e", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "resources", "equipments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "31461018-e3f3-4fe5-965b-606dd8324dcb", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "resources", "equipments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "db6229e6-a7ac-42c4-8115-95b4e69646dc", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "resources", "equipments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "5853804c-30b9-4499-939f-a8a94e613b84", "name": "List calendar equipments", "request": { "name": "List calendar equipments", "description": {}, "url": { "path": [ "api", "v2", "scheduling", "calendars", "resources", "equipments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "2d2a6a62-4426-4e46-8f31-f39334c6e950", "name": "Page of calendar equipments", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "resources", "equipments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d36257bb-5136-4785-8f34-402adc015422", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "resources", "equipments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1f53300d-604b-4e53-90d9-407b8f6c8a74", "name": "Authenticated user is missing the `VER_CALENDARIORECURSOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "resources", "equipments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6ad8c6dd-9fda-4670-9430-affc3efdf1d6", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "resources", "equipments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2805f9bc-365d-419d-a113-9bc7bb8ea156", "name": "Create calendar equipment", "request": { "name": "Create calendar equipment", "description": {}, "url": { "path": [ "api", "v2", "scheduling", "calendars", "resources", "equipments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"resourceType\": \"EQUIPMENT\",\n \"quantity\": \"\",\n \"capacity\": \"\",\n \"outOfService\": \"\",\n \"calendarIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "68a32785-9547-4256-aceb-763f7f54a416", "name": "Calendar equipment created", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "resources", "equipments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"resourceType\": \"EQUIPMENT\",\n \"quantity\": \"\",\n \"capacity\": \"\",\n \"outOfService\": \"\",\n \"calendarIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"resourceType\": \"ROOM\",\n \"quantity\": \"\",\n \"capacity\": \"\",\n \"outOfService\": \"\",\n \"calendarIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\",\n \"companyName\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "52ccfa1f-7e2f-4f44-aaec-7a9a678aa670", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "resources", "equipments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"resourceType\": \"EQUIPMENT\",\n \"quantity\": \"\",\n \"capacity\": \"\",\n \"outOfService\": \"\",\n \"calendarIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2a2c372c-efd3-41f6-a109-58325a4a9a33", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "resources", "equipments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"resourceType\": \"EQUIPMENT\",\n \"quantity\": \"\",\n \"capacity\": \"\",\n \"outOfService\": \"\",\n \"calendarIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "groups", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "26951b09-0e28-4365-b522-acf39f7ff0af", "name": "Get calendar group by ID", "request": { "name": "Get calendar group by ID", "description": {}, "url": { "path": [ "api", "v2", "scheduling", "calendars", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Calendar group ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "1dcf6c30-edc0-4e08-b463-b7ac63fe3199", "name": "Calendar group found", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar group ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"active\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "db3c571f-4d50-40b3-aec7-d79c5e407151", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar group ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b7164e5c-152d-4c2c-bf99-2a45ac402b74", "name": "Authenticated user is missing the `VER_CALENDARIOGRUPOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar group ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cc01e22c-cf97-4452-bfc0-6cfbb2f4ae25", "name": "Calendar group not found", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar group ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "af65d113-9c19-4eef-9c52-acf8d3ffc9b6", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar group ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5d397b20-50f2-4cfc-b39f-e55e24ec20c2", "name": "Update calendar group", "request": { "name": "Update calendar group", "description": {}, "url": { "path": [ "api", "v2", "scheduling", "calendars", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Calendar group ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"active\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "5f95d8da-8abf-402b-be55-a56114e8547d", "name": "Calendar group updated", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar group ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"active\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"active\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b57b5d4d-55d0-4b75-a9bc-1afc93a17305", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar group ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"active\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "29629a83-30e3-4f7b-9464-edfe5c1037f4", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar group ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"active\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "91e2b664-095f-47c3-b4cf-b8dafc1c4a5a", "name": "Authenticated user is missing the `EDITAR_CALENDARIOGRUPOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar group ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"active\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a378676f-c5f7-46c3-994b-759fbe20bc72", "name": "Calendar group not found", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar group ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"active\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8d9f1657-f5e4-4b5a-bd28-a2f0affea1f5", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar group ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"active\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "84dc04da-5976-416f-a48a-8b78108c5bd6", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar group ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"active\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a8c1c2ef-71a0-4c79-b370-621fdaa678e1", "name": "Delete calendar group", "request": { "name": "Delete calendar group", "description": {}, "url": { "path": [ "api", "v2", "scheduling", "calendars", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Calendar group ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "4fbca9b3-5d3e-451d-84dd-2ba2c639f231", "name": "Calendar group deleted", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar group ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b15b7cbb-0f28-490e-91c5-d23d34cb6a87", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar group ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b88b4786-9e07-4648-aa52-9c815574f514", "name": "Authenticated user is missing the `BORRAR_CALENDARIOGRUPOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar group ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9df22833-212f-472e-a1ba-f5e98a83dbe5", "name": "Calendar group not found", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar group ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e86faf01-580b-4055-853e-56d13fe0fcda", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar group ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "31e73271-dbf1-4a4e-a3d8-4bb38f206cf0", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar group ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5deda354-d48f-40fc-b841-fabec2faa4e4", "name": "Merge-patch calendar group", "request": { "name": "Merge-patch calendar group", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "scheduling", "calendars", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Calendar group ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "9e57ff2a-c270-4ce7-93b0-ca4c1c1cef76", "name": "Calendar group patched", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar group ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"active\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5c0cde36-e411-4d2a-b205-a8b76cc6765b", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar group ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e0abed3f-c62a-402c-a72c-1b48172df8f2", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar group ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "413c21ca-da6b-4e7f-bee7-91d5095d3fab", "name": "Authenticated user is missing the `EDITAR_CALENDARIOGRUPOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar group ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e0984f08-354c-404e-8c75-53466283255e", "name": "Calendar group not found", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar group ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6bad3236-bdfb-480f-b679-57360df12bd9", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar group ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "71a3a356-d4d0-4dcd-96e4-666a583befd0", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar group ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "d7b416d4-a75f-4cfb-b94f-9ae773c24700", "name": "List calendar groups", "request": { "name": "List calendar groups", "description": { "content": "Returns a paginated list of calendar groups with envelope `{data, totalCount, skip, limit, hasMore}`. Default sort is `name:asc`. Limit is capped at 200; skip is clamped to >= 0.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "scheduling", "calendars", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "65b72921-f2c1-4bc8-9dcc-0a31d138857e", "name": "Page of calendar groups", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ea5799dd-95c8-4c2a-b575-1ac1f6ff214e", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "174e8b81-2699-4d63-a39a-06690b26893e", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "99d021a5-daf0-43e4-bf41-f9fb5987c674", "name": "Authenticated user is missing the `VER_CALENDARIOGRUPOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9b728da3-c31c-431d-b011-84c89949297a", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f8e6c946-b5db-49ee-a88b-47a6c4bf0bad", "name": "Create calendar group", "request": { "name": "Create calendar group", "description": {}, "url": { "path": [ "api", "v2", "scheduling", "calendars", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"active\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "09c526d9-1b75-4f25-8c67-51964b1e0315", "name": "Calendar group created", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"active\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"active\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "84710b63-0025-4670-b8f6-0179ec4f2f80", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"active\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e04ddcc1-f61b-4bb5-b83b-a2b384ace50c", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"active\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9939726a-6681-4235-9e3e-4042a43a551a", "name": "Authenticated user is missing the `CREAR_CALENDARIOGRUPOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"active\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "589ff6e3-1cd6-4f92-b8aa-5a30df55d8e7", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"active\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "a2ef5f8b-7e93-4013-a607-8418b4c0ca89", "name": "List calendars", "request": { "name": "List calendars", "description": { "content": "Returns a paginated list of calendars with the full GHL-like contract. Envelope `{data, totalCount, skip, limit, hasMore}`. Default sort `name:asc`. Limit capped at 200.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "scheduling", "calendars" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "1557808c-d172-40fc-9334-74b39d4de958", "name": "Page of calendars", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f61e0fb0-551f-4ea3-81e5-afd0785c3637", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6b375837-b103-4aa7-abfe-03d2fc0cfc6b", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6e86cef6-410f-4d1b-b752-0d294350826a", "name": "Authenticated user is missing the `VER_CALENDARIOUI` permission", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "059dbf8a-09e9-47c8-9b55-7dc122679a8f", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f859bc0e-fd01-46f0-9cd9-e246d823a610", "name": "Create calendar", "request": { "name": "Create calendar", "description": { "content": "Creates a calendar with GHL-like validation (personal/collective/branch teamMember rules). Persisted via the WAR command gateway so CalendarioListener fires.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "scheduling", "calendars" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"widgetSlug\": \"\",\n \"widgetType\": \"classic\",\n \"eventTitle\": \"\",\n \"color\": \"\",\n \"active\": \"\",\n \"enabled\": \"\",\n \"groupId\": \"\",\n \"calendarType\": \"event\",\n \"legacyCalendarType\": \"SERVICIO\",\n \"eventType\": \"RoundRobin_OptimizeForEqualDistribution\",\n \"teamMembers\": [\n {\n \"employeeId\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"zoom_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n },\n {\n \"employeeId\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"inbound_call\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n }\n ],\n \"employeeIds\": [\n \"\",\n \"\"\n ],\n \"slotDuration\": \"\",\n \"slotDurationUnit\": \"mins\",\n \"defaultDurationMinutes\": \"\",\n \"slotMinutes\": \"\",\n \"defaultView\": \"MES\",\n \"timeUnit\": \"MINUTES\",\n \"predefinedSlots\": \"\",\n \"slotInterval\": \"\",\n \"slotIntervalUnit\": \"\",\n \"slotBuffer\": \"\",\n \"slotBufferUnit\": \"\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"\",\n \"appoinmentPerSlot\": \"\",\n \"appoinmentPerDay\": \"\",\n \"allowBookingAfter\": \"\",\n \"allowBookingAfterUnit\": \"\",\n \"allowBookingFor\": \"\",\n \"allowBookingForUnit\": \"\",\n \"openHours\": [\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n },\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n }\n ],\n \"availabilities\": [\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n },\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n }\n ],\n \"availabilityType\": \"\",\n \"openingTime\": \"\",\n \"closingTime\": \"\",\n \"enableRecurring\": \"\",\n \"recurring\": {\n \"freq\": \"WEEKLY\",\n \"count\": \"\",\n \"bookingOption\": \"book_next\",\n \"bookingOverlapDefaultStatus\": \"new\"\n },\n \"lookBusyConfig\": {\n \"enabled\": \"\",\n \"LookBusyPercentage\": \"\"\n },\n \"formId\": \"\",\n \"formSubmitType\": \"ThankYouMessage\",\n \"formSubmitRedirectUrl\": \"\",\n \"formSubmitThanksMessage\": \"\",\n \"autoConfirm\": \"\",\n \"allowReschedule\": \"\",\n \"allowCancellation\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "2c29b455-1658-4fee-aae9-a8d65a31b350", "name": "Calendar created", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"widgetSlug\": \"\",\n \"widgetType\": \"classic\",\n \"eventTitle\": \"\",\n \"color\": \"\",\n \"active\": \"\",\n \"enabled\": \"\",\n \"groupId\": \"\",\n \"calendarType\": \"event\",\n \"legacyCalendarType\": \"SERVICIO\",\n \"eventType\": \"RoundRobin_OptimizeForEqualDistribution\",\n \"teamMembers\": [\n {\n \"employeeId\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"zoom_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n },\n {\n \"employeeId\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"inbound_call\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n }\n ],\n \"employeeIds\": [\n \"\",\n \"\"\n ],\n \"slotDuration\": \"\",\n \"slotDurationUnit\": \"mins\",\n \"defaultDurationMinutes\": \"\",\n \"slotMinutes\": \"\",\n \"defaultView\": \"MES\",\n \"timeUnit\": \"MINUTES\",\n \"predefinedSlots\": \"\",\n \"slotInterval\": \"\",\n \"slotIntervalUnit\": \"\",\n \"slotBuffer\": \"\",\n \"slotBufferUnit\": \"\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"\",\n \"appoinmentPerSlot\": \"\",\n \"appoinmentPerDay\": \"\",\n \"allowBookingAfter\": \"\",\n \"allowBookingAfterUnit\": \"\",\n \"allowBookingFor\": \"\",\n \"allowBookingForUnit\": \"\",\n \"openHours\": [\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n },\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n }\n ],\n \"availabilities\": [\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n },\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n }\n ],\n \"availabilityType\": \"\",\n \"openingTime\": \"\",\n \"closingTime\": \"\",\n \"enableRecurring\": \"\",\n \"recurring\": {\n \"freq\": \"WEEKLY\",\n \"count\": \"\",\n \"bookingOption\": \"book_next\",\n \"bookingOverlapDefaultStatus\": \"new\"\n },\n \"lookBusyConfig\": {\n \"enabled\": \"\",\n \"LookBusyPercentage\": \"\"\n },\n \"formId\": \"\",\n \"formSubmitType\": \"ThankYouMessage\",\n \"formSubmitRedirectUrl\": \"\",\n \"formSubmitThanksMessage\": \"\",\n \"autoConfirm\": \"\",\n \"allowReschedule\": \"\",\n \"allowCancellation\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"widgetSlug\": \"\",\n \"widgetType\": \"default\",\n \"eventTitle\": \"\",\n \"color\": \"\",\n \"active\": \"\",\n \"enabled\": \"\",\n \"groupId\": \"\",\n \"groupName\": \"\",\n \"calendarType\": \"service_booking\",\n \"legacyCalendarType\": \"SERVICIO\",\n \"eventType\": \"RoundRobin_OptimizeForEqualDistribution\",\n \"teamMembers\": [\n {\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"custom\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"inbound_call\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n },\n {\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"booker\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n }\n ],\n \"employeeIds\": [\n \"\",\n \"\"\n ],\n \"slotDuration\": \"\",\n \"slotDurationUnit\": \"hours\",\n \"defaultDurationMinutes\": \"\",\n \"slotMinutes\": \"\",\n \"defaultView\": \"DIA\",\n \"timeUnit\": \"MINUTES\",\n \"predefinedSlots\": \"\",\n \"slotInterval\": \"\",\n \"slotIntervalUnit\": \"\",\n \"slotBuffer\": \"\",\n \"slotBufferUnit\": \"\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"\",\n \"appoinmentPerSlot\": \"\",\n \"appoinmentPerDay\": \"\",\n \"allowBookingAfter\": \"\",\n \"allowBookingAfterUnit\": \"\",\n \"allowBookingFor\": \"\",\n \"allowBookingForUnit\": \"\",\n \"openHours\": [\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n },\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n }\n ],\n \"availabilities\": [\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n },\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n }\n ],\n \"availabilityType\": \"\",\n \"openingTime\": \"\",\n \"closingTime\": \"\",\n \"enableRecurring\": \"\",\n \"recurring\": {\n \"freq\": \"WEEKLY\",\n \"count\": \"\",\n \"bookingOption\": \"book_next\",\n \"bookingOverlapDefaultStatus\": \"new\"\n },\n \"lookBusyConfig\": {\n \"enabled\": \"\",\n \"LookBusyPercentage\": \"\"\n },\n \"formId\": \"\",\n \"formSubmitType\": \"RedirectURL\",\n \"formSubmitRedirectUrl\": \"\",\n \"formSubmitThanksMessage\": \"\",\n \"autoConfirm\": \"\",\n \"allowReschedule\": \"\",\n \"allowCancellation\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d77f4b00-07de-4c27-aef2-e9a16d58aa79", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"widgetSlug\": \"\",\n \"widgetType\": \"classic\",\n \"eventTitle\": \"\",\n \"color\": \"\",\n \"active\": \"\",\n \"enabled\": \"\",\n \"groupId\": \"\",\n \"calendarType\": \"event\",\n \"legacyCalendarType\": \"SERVICIO\",\n \"eventType\": \"RoundRobin_OptimizeForEqualDistribution\",\n \"teamMembers\": [\n {\n \"employeeId\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"zoom_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n },\n {\n \"employeeId\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"inbound_call\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n }\n ],\n \"employeeIds\": [\n \"\",\n \"\"\n ],\n \"slotDuration\": \"\",\n \"slotDurationUnit\": \"mins\",\n \"defaultDurationMinutes\": \"\",\n \"slotMinutes\": \"\",\n \"defaultView\": \"MES\",\n \"timeUnit\": \"MINUTES\",\n \"predefinedSlots\": \"\",\n \"slotInterval\": \"\",\n \"slotIntervalUnit\": \"\",\n \"slotBuffer\": \"\",\n \"slotBufferUnit\": \"\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"\",\n \"appoinmentPerSlot\": \"\",\n \"appoinmentPerDay\": \"\",\n \"allowBookingAfter\": \"\",\n \"allowBookingAfterUnit\": \"\",\n \"allowBookingFor\": \"\",\n \"allowBookingForUnit\": \"\",\n \"openHours\": [\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n },\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n }\n ],\n \"availabilities\": [\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n },\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n }\n ],\n \"availabilityType\": \"\",\n \"openingTime\": \"\",\n \"closingTime\": \"\",\n \"enableRecurring\": \"\",\n \"recurring\": {\n \"freq\": \"WEEKLY\",\n \"count\": \"\",\n \"bookingOption\": \"book_next\",\n \"bookingOverlapDefaultStatus\": \"new\"\n },\n \"lookBusyConfig\": {\n \"enabled\": \"\",\n \"LookBusyPercentage\": \"\"\n },\n \"formId\": \"\",\n \"formSubmitType\": \"ThankYouMessage\",\n \"formSubmitRedirectUrl\": \"\",\n \"formSubmitThanksMessage\": \"\",\n \"autoConfirm\": \"\",\n \"allowReschedule\": \"\",\n \"allowCancellation\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "dd759f78-06b4-461c-a184-ab4c71e58576", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"widgetSlug\": \"\",\n \"widgetType\": \"classic\",\n \"eventTitle\": \"\",\n \"color\": \"\",\n \"active\": \"\",\n \"enabled\": \"\",\n \"groupId\": \"\",\n \"calendarType\": \"event\",\n \"legacyCalendarType\": \"SERVICIO\",\n \"eventType\": \"RoundRobin_OptimizeForEqualDistribution\",\n \"teamMembers\": [\n {\n \"employeeId\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"zoom_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n },\n {\n \"employeeId\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"inbound_call\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n }\n ],\n \"employeeIds\": [\n \"\",\n \"\"\n ],\n \"slotDuration\": \"\",\n \"slotDurationUnit\": \"mins\",\n \"defaultDurationMinutes\": \"\",\n \"slotMinutes\": \"\",\n \"defaultView\": \"MES\",\n \"timeUnit\": \"MINUTES\",\n \"predefinedSlots\": \"\",\n \"slotInterval\": \"\",\n \"slotIntervalUnit\": \"\",\n \"slotBuffer\": \"\",\n \"slotBufferUnit\": \"\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"\",\n \"appoinmentPerSlot\": \"\",\n \"appoinmentPerDay\": \"\",\n \"allowBookingAfter\": \"\",\n \"allowBookingAfterUnit\": \"\",\n \"allowBookingFor\": \"\",\n \"allowBookingForUnit\": \"\",\n \"openHours\": [\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n },\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n }\n ],\n \"availabilities\": [\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n },\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n }\n ],\n \"availabilityType\": \"\",\n \"openingTime\": \"\",\n \"closingTime\": \"\",\n \"enableRecurring\": \"\",\n \"recurring\": {\n \"freq\": \"WEEKLY\",\n \"count\": \"\",\n \"bookingOption\": \"book_next\",\n \"bookingOverlapDefaultStatus\": \"new\"\n },\n \"lookBusyConfig\": {\n \"enabled\": \"\",\n \"LookBusyPercentage\": \"\"\n },\n \"formId\": \"\",\n \"formSubmitType\": \"ThankYouMessage\",\n \"formSubmitRedirectUrl\": \"\",\n \"formSubmitThanksMessage\": \"\",\n \"autoConfirm\": \"\",\n \"allowReschedule\": \"\",\n \"allowCancellation\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "eec073ca-0863-4321-aba2-d3edd0e270fc", "name": "Authenticated user is missing the `CREAR_CALENDARIOUI` permission", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"widgetSlug\": \"\",\n \"widgetType\": \"classic\",\n \"eventTitle\": \"\",\n \"color\": \"\",\n \"active\": \"\",\n \"enabled\": \"\",\n \"groupId\": \"\",\n \"calendarType\": \"event\",\n \"legacyCalendarType\": \"SERVICIO\",\n \"eventType\": \"RoundRobin_OptimizeForEqualDistribution\",\n \"teamMembers\": [\n {\n \"employeeId\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"zoom_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n },\n {\n \"employeeId\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"inbound_call\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n }\n ],\n \"employeeIds\": [\n \"\",\n \"\"\n ],\n \"slotDuration\": \"\",\n \"slotDurationUnit\": \"mins\",\n \"defaultDurationMinutes\": \"\",\n \"slotMinutes\": \"\",\n \"defaultView\": \"MES\",\n \"timeUnit\": \"MINUTES\",\n \"predefinedSlots\": \"\",\n \"slotInterval\": \"\",\n \"slotIntervalUnit\": \"\",\n \"slotBuffer\": \"\",\n \"slotBufferUnit\": \"\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"\",\n \"appoinmentPerSlot\": \"\",\n \"appoinmentPerDay\": \"\",\n \"allowBookingAfter\": \"\",\n \"allowBookingAfterUnit\": \"\",\n \"allowBookingFor\": \"\",\n \"allowBookingForUnit\": \"\",\n \"openHours\": [\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n },\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n }\n ],\n \"availabilities\": [\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n },\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n }\n ],\n \"availabilityType\": \"\",\n \"openingTime\": \"\",\n \"closingTime\": \"\",\n \"enableRecurring\": \"\",\n \"recurring\": {\n \"freq\": \"WEEKLY\",\n \"count\": \"\",\n \"bookingOption\": \"book_next\",\n \"bookingOverlapDefaultStatus\": \"new\"\n },\n \"lookBusyConfig\": {\n \"enabled\": \"\",\n \"LookBusyPercentage\": \"\"\n },\n \"formId\": \"\",\n \"formSubmitType\": \"ThankYouMessage\",\n \"formSubmitRedirectUrl\": \"\",\n \"formSubmitThanksMessage\": \"\",\n \"autoConfirm\": \"\",\n \"allowReschedule\": \"\",\n \"allowCancellation\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "df27853f-10a1-4912-a594-21c6e4310384", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "calendars" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"widgetSlug\": \"\",\n \"widgetType\": \"classic\",\n \"eventTitle\": \"\",\n \"color\": \"\",\n \"active\": \"\",\n \"enabled\": \"\",\n \"groupId\": \"\",\n \"calendarType\": \"event\",\n \"legacyCalendarType\": \"SERVICIO\",\n \"eventType\": \"RoundRobin_OptimizeForEqualDistribution\",\n \"teamMembers\": [\n {\n \"employeeId\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"zoom_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n },\n {\n \"employeeId\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"inbound_call\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n }\n ],\n \"employeeIds\": [\n \"\",\n \"\"\n ],\n \"slotDuration\": \"\",\n \"slotDurationUnit\": \"mins\",\n \"defaultDurationMinutes\": \"\",\n \"slotMinutes\": \"\",\n \"defaultView\": \"MES\",\n \"timeUnit\": \"MINUTES\",\n \"predefinedSlots\": \"\",\n \"slotInterval\": \"\",\n \"slotIntervalUnit\": \"\",\n \"slotBuffer\": \"\",\n \"slotBufferUnit\": \"\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"\",\n \"appoinmentPerSlot\": \"\",\n \"appoinmentPerDay\": \"\",\n \"allowBookingAfter\": \"\",\n \"allowBookingAfterUnit\": \"\",\n \"allowBookingFor\": \"\",\n \"allowBookingForUnit\": \"\",\n \"openHours\": [\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n },\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n }\n ],\n \"availabilities\": [\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n },\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n }\n ],\n \"availabilityType\": \"\",\n \"openingTime\": \"\",\n \"closingTime\": \"\",\n \"enableRecurring\": \"\",\n \"recurring\": {\n \"freq\": \"WEEKLY\",\n \"count\": \"\",\n \"bookingOption\": \"book_next\",\n \"bookingOverlapDefaultStatus\": \"new\"\n },\n \"lookBusyConfig\": {\n \"enabled\": \"\",\n \"LookBusyPercentage\": \"\"\n },\n \"formId\": \"\",\n \"formSubmitType\": \"ThankYouMessage\",\n \"formSubmitRedirectUrl\": \"\",\n \"formSubmitThanksMessage\": \"\",\n \"autoConfirm\": \"\",\n \"allowReschedule\": \"\",\n \"allowCancellation\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "appointments", "description": "", "item": [ { "name": "{appointmentId}", "description": "", "item": [ { "name": "notes", "description": "", "item": [ { "name": "{noteId}", "description": "", "item": [ { "id": "d7f64800-12cf-4532-a6db-83d4cd9a64b9", "name": "Get appointment note by ID", "request": { "name": "Get appointment note by ID", "description": {}, "url": { "path": [ "api", "v2", "scheduling", "appointments", ":appointmentId", "notes", ":noteId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "appointmentId", "disabled": false, "description": { "content": "(Required) Owning appointment ID", "type": "text/plain" } }, { "type": "any", "value": "", "key": "noteId", "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "1e5aba9b-c179-4e74-9e2c-be2dedb328fd", "name": "Note found", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "appointments", ":appointmentId", "notes", ":noteId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Owning appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "appointmentId" }, { "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "noteId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"appointmentId\": \"\",\n \"body\": \"\",\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"companyId\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "00ba2735-8e2e-41a7-a4f3-241076777300", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "appointments", ":appointmentId", "notes", ":noteId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Owning appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "appointmentId" }, { "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "noteId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7b7408f6-6d82-4032-8ec5-3b473f98e88d", "name": "Authenticated user is missing the `VER_EVENTO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "appointments", ":appointmentId", "notes", ":noteId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Owning appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "appointmentId" }, { "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "noteId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a2567b24-37c0-47c3-a2d8-804cf9b02e41", "name": "Note not found on that appointment", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "appointments", ":appointmentId", "notes", ":noteId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Owning appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "appointmentId" }, { "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "noteId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e80644d1-41ba-4ea9-a84c-f405ced073fc", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "appointments", ":appointmentId", "notes", ":noteId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Owning appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "appointmentId" }, { "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "noteId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6acf66a1-f9d1-45e9-ae2a-a303c9166bad", "name": "Update appointment note", "request": { "name": "Update appointment note", "description": { "content": "Full replacement of an existing note.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "scheduling", "appointments", ":appointmentId", "notes", ":noteId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "appointmentId", "disabled": false, "description": { "content": "(Required) Owning appointment ID", "type": "text/plain" } }, { "type": "any", "value": "", "key": "noteId", "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"body\": \"\",\n \"employeeId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "e61e97c8-2cf0-4d46-b7cc-774ca0febf5f", "name": "Note updated", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "appointments", ":appointmentId", "notes", ":noteId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Owning appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "appointmentId" }, { "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "noteId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"body\": \"\",\n \"employeeId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"appointmentId\": \"\",\n \"body\": \"\",\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"companyId\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3d308a8f-1920-40d6-bf72-b3c64eb21144", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "appointments", ":appointmentId", "notes", ":noteId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Owning appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "appointmentId" }, { "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "noteId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"body\": \"\",\n \"employeeId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b46d96cf-cb13-4544-a07a-4c976dde2c95", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "appointments", ":appointmentId", "notes", ":noteId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Owning appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "appointmentId" }, { "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "noteId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"body\": \"\",\n \"employeeId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "418bf67c-5770-45c3-a405-dcc9a2d41dab", "name": "Authenticated user is missing the `EDITAR_EVENTO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "appointments", ":appointmentId", "notes", ":noteId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Owning appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "appointmentId" }, { "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "noteId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"body\": \"\",\n \"employeeId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2f443817-e2e7-4a09-a303-368881ee6e43", "name": "Note not found on that appointment", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "appointments", ":appointmentId", "notes", ":noteId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Owning appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "appointmentId" }, { "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "noteId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"body\": \"\",\n \"employeeId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d202cad3-5502-4f65-a0e0-2a30138d4081", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "appointments", ":appointmentId", "notes", ":noteId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Owning appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "appointmentId" }, { "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "noteId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"body\": \"\",\n \"employeeId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6254e1de-5583-470f-913c-ffcf2e9b823b", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "appointments", ":appointmentId", "notes", ":noteId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Owning appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "appointmentId" }, { "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "noteId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"body\": \"\",\n \"employeeId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "60e14d17-c78a-4dc6-bef7-057b15f26e2d", "name": "Delete appointment note", "request": { "name": "Delete appointment note", "description": {}, "url": { "path": [ "api", "v2", "scheduling", "appointments", ":appointmentId", "notes", ":noteId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "appointmentId", "disabled": false, "description": { "content": "(Required) Owning appointment ID", "type": "text/plain" } }, { "type": "any", "value": "", "key": "noteId", "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "3d335022-856f-4fb4-ad63-cb198b39df3a", "name": "Note deleted", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "appointments", ":appointmentId", "notes", ":noteId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Owning appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "appointmentId" }, { "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "noteId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1938770b-d6e5-4ce7-aa2e-fa9ef3caadec", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "appointments", ":appointmentId", "notes", ":noteId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Owning appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "appointmentId" }, { "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "noteId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "76dbabeb-d120-4029-ba72-56e22ba65c74", "name": "Authenticated user is missing the `EDITAR_EVENTO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "appointments", ":appointmentId", "notes", ":noteId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Owning appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "appointmentId" }, { "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "noteId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9cd0d3b7-edfa-4b93-b6e2-7d83ef991504", "name": "Note not found on that appointment", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "appointments", ":appointmentId", "notes", ":noteId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Owning appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "appointmentId" }, { "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "noteId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f1e10345-d415-41ac-9b5a-41bb7ffde380", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "appointments", ":appointmentId", "notes", ":noteId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Owning appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "appointmentId" }, { "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "noteId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5ef8aee9-a656-4dd9-a535-a0d94668c298", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "appointments", ":appointmentId", "notes", ":noteId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Owning appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "appointmentId" }, { "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "noteId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f719d47a-77bf-494f-abf2-d515f0493aad", "name": "Merge-patch appointment note", "request": { "name": "Merge-patch appointment note", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "scheduling", "appointments", ":appointmentId", "notes", ":noteId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "appointmentId", "disabled": false, "description": { "content": "(Required) Owning appointment ID", "type": "text/plain" } }, { "type": "any", "value": "", "key": "noteId", "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "9dda68bb-cf7f-4f51-8b4c-826634667a41", "name": "Note patched", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "appointments", ":appointmentId", "notes", ":noteId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Owning appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "appointmentId" }, { "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "noteId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"appointmentId\": \"\",\n \"body\": \"\",\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"companyId\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c2dfb37e-faa7-46d9-94b9-92ddc3d50668", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details. Also returned for malformed merge-patch payloads.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "appointments", ":appointmentId", "notes", ":noteId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Owning appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "appointmentId" }, { "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "noteId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bbad282a-1c78-4824-bf93-58b2eaa7799d", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "appointments", ":appointmentId", "notes", ":noteId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Owning appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "appointmentId" }, { "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "noteId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a811402b-0eda-4024-93c1-88bec83b16d8", "name": "Authenticated user is missing the `EDITAR_EVENTO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "appointments", ":appointmentId", "notes", ":noteId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Owning appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "appointmentId" }, { "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "noteId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e0ad57c5-94e2-42d0-a168-5e97ac11b1cb", "name": "Note not found on that appointment", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "appointments", ":appointmentId", "notes", ":noteId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Owning appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "appointmentId" }, { "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "noteId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "84b7abd9-f56f-4164-bcb3-4bb0087b50e3", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "appointments", ":appointmentId", "notes", ":noteId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Owning appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "appointmentId" }, { "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "noteId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b88eeab6-97e6-4957-ac68-4c6725f9af9f", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "appointments", ":appointmentId", "notes", ":noteId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Owning appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "appointmentId" }, { "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "noteId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "c4bb0cb7-18d8-4044-bced-4ef4442e7db5", "name": "List appointment notes", "request": { "name": "List appointment notes", "description": { "content": "Returns a paginated list of the notes of one appointment, with envelope `{data, totalCount, skip, limit, hasMore}`. Default sort is `createdAt:desc`. Limit is capped at 200; skip is clamped to >= 0.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "scheduling", "appointments", ":appointmentId", "notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "createdAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [ { "type": "any", "value": "", "key": "appointmentId", "disabled": false, "description": { "content": "(Required) Owning appointment ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "e270c444-4b07-40d9-977f-aae32e1cc437", "name": "Page of notes", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "appointments", ":appointmentId", "notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "createdAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Owning appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "appointmentId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b0817cb3-a196-47f4-98a9-1a7980c57c5c", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "appointments", ":appointmentId", "notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "createdAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Owning appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "appointmentId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4ca47d8a-665a-47dc-af7a-ff2381ec9d6a", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "appointments", ":appointmentId", "notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "createdAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Owning appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "appointmentId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "79c73772-d036-4c70-ad23-95a44ef1090e", "name": "Authenticated user is missing the `VER_EVENTO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "appointments", ":appointmentId", "notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "createdAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Owning appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "appointmentId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "dddd8e1f-f87a-4fdb-aff3-1600a20bde17", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "appointments", ":appointmentId", "notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "createdAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Owning appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "appointmentId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4a3d49fd-085a-40b2-bd2f-39dc42cacfc4", "name": "Create appointment note", "request": { "name": "Create appointment note", "description": { "content": "Adds a note to an appointment. The owning appointment comes from the path; `appointmentId` in the body is ignored.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "scheduling", "appointments", ":appointmentId", "notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "appointmentId", "disabled": false, "description": { "content": "(Required) Owning appointment ID", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"body\": \"\",\n \"employeeId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "5b6ff77b-e1f3-4dba-89f2-6ed8bceb38e6", "name": "Note created", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "appointments", ":appointmentId", "notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Owning appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "appointmentId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"body\": \"\",\n \"employeeId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"appointmentId\": \"\",\n \"body\": \"\",\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"companyId\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f6df1843-90de-4f43-a99f-5c0e49d8dffe", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "appointments", ":appointmentId", "notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Owning appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "appointmentId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"body\": \"\",\n \"employeeId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b05ea4fd-98fc-46fa-9f78-287e595760d6", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "appointments", ":appointmentId", "notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Owning appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "appointmentId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"body\": \"\",\n \"employeeId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b01667d9-ad74-4e2a-b774-9e64ec142d7f", "name": "Authenticated user is missing the `EDITAR_EVENTO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "appointments", ":appointmentId", "notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Owning appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "appointmentId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"body\": \"\",\n \"employeeId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a817cd40-b22a-42ec-b453-ee6f1493b0d3", "name": "Appointment not found", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "appointments", ":appointmentId", "notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Owning appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "appointmentId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"body\": \"\",\n \"employeeId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "943ac9dc-6cb1-49c2-a5bf-025b50ec4425", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "scheduling", "appointments", ":appointmentId", "notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Owning appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "appointmentId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"body\": \"\",\n \"employeeId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] } ] }, { "name": "sales-quotes", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "7ee84c77-85fd-44a2-a6e1-a26c94532a4c", "name": "Get sales quote by ID", "request": { "name": "Get sales quote by ID", "description": { "content": "Returns a single customer sales quote by its primary key, including line items and payments. Listing (`GET` without id) returns headers only. The response carries a strong `ETag` header with the current version.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "sales-quotes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Sales quote ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "0c59bc55-47b2-4858-a8a5-b98f77621473", "name": "Sales quote found", "originalRequest": { "url": { "path": [ "api", "v2", "sales-quotes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales quote ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"documentType\": \"DELIVERY_NOTE\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"deliveryStatus\": \"P\",\n \"lifecycleStatus\": \"\",\n \"paymentStatus\": \"OVERPAID\",\n \"documentStatusId\": \"\",\n \"documentStatusName\": \"\",\n \"issued\": \"\",\n \"draft\": \"\",\n \"enabled\": \"\",\n \"verified\": \"\",\n \"documentDate\": \"\",\n \"shippingDate\": \"\",\n \"counterpartyName\": \"\",\n \"counterpartyTaxId\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"companyTaxId\": \"\",\n \"warehouseName\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"optometristId\": \"\",\n \"optometristName\": \"\",\n \"documentTypeId\": \"\",\n \"documentTypeName\": \"\",\n \"paymentTermsId\": \"\",\n \"paymentTermsName\": \"\",\n \"basePriceListId\": \"\",\n \"basePriceListName\": \"\",\n \"discountPriceListId\": \"\",\n \"discountPriceListName\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"withholdingTaxTypeName\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"totalQuantity\": \"\",\n \"grossAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"discountAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"specialDiscountPct\": \"\",\n \"specialDiscountAmount\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"earlyPaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatAmount\": \"\",\n \"surchargeEquivalencePct\": \"\",\n \"surchargeEquivalenceAmount\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"withholdingTaxAmount\": \"\",\n \"shippingAmount\": \"\",\n \"financingPct\": \"\",\n \"financingAmount\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"commercialTotalAmount\": \"\",\n \"total\": \"\",\n \"totalPaid\": \"\",\n \"outstandingAmount\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"currencyDecimals\": \"\",\n \"currencyDecimalsSystem\": \"\",\n \"exchangeRate\": \"\",\n \"grossAmountSystem\": \"\",\n \"discountAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"roundingMode\": \"\",\n \"relationConcept\": \"\",\n \"relationType\": \"\",\n \"linkableQuantity\": \"\",\n \"relationQuantity\": \"\",\n \"totalApprovals\": \"\",\n \"validatedApprovals\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"LOAD\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"RI\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"MC\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"grossAmount\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatPct\": \"\",\n \"vatAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"surchargePct\": \"\",\n \"surchargeAmount\": \"\",\n \"total\": \"\",\n \"commercialTotalAmount\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"id\": \"\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n },\n {\n \"type\": \"DISCOUNT\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n }\n ],\n \"appliedPriceRule\": {\n \"id\": \"\",\n \"ruleType\": \"DISCOUNT\",\n \"tariffId\": \"\",\n \"tariffName\": \"\",\n \"comboId\": \"\",\n \"comboName\": \"\",\n \"purchaseCondition\": \"\",\n \"purchaseConditionId\": \"\",\n \"discountConditionId\": \"\",\n \"discountValue\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ]\n },\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"grossAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"reservedQuantity\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"INVENTORY_TRANSFER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"opticalOrderId\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"grossAmount\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatPct\": \"\",\n \"vatAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"surchargePct\": \"\",\n \"surchargeAmount\": \"\",\n \"total\": \"\",\n \"commercialTotalAmount\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n },\n {\n \"type\": \"COMBO\",\n \"id\": \"\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n }\n ],\n \"appliedPriceRule\": {\n \"id\": \"\",\n \"ruleType\": \"COMBO\",\n \"tariffId\": \"\",\n \"tariffName\": \"\",\n \"comboId\": \"\",\n \"comboName\": \"\",\n \"purchaseCondition\": \"\",\n \"purchaseConditionId\": \"\",\n \"discountConditionId\": \"\",\n \"discountValue\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ]\n },\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"grossAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"reservedQuantity\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"OPTICAL_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"REPAIR_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"opticalOrderId\": \"\"\n }\n ],\n \"validUntilDate\": \"\",\n \"proforma\": \"\",\n \"discountVoucherId\": \"\",\n \"discountVoucherCode\": \"\",\n \"autoIssueDiscountVoucher\": \"\",\n \"visitReasonId\": \"\",\n \"visitReasonName\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cbde8c1b-acd7-422f-addf-1165625158de", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "sales-quotes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales quote ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "878b9ae1-25c2-4f7a-8c61-1ee0816e5a95", "name": "Authenticated user is missing the `VER_PRESUPUESTOSEMITIDOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "sales-quotes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales quote ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f5f7c734-491d-4900-8822-217dc9883c92", "name": "Sales quote not found", "originalRequest": { "url": { "path": [ "api", "v2", "sales-quotes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales quote ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f99711b3-ffa3-431b-8b86-3a3d3bd682f7", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-quotes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales quote ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2abf587e-2a28-4924-a6f0-093c16ca4c48", "name": "Update sales quote", "request": { "name": "Update sales quote", "description": { "content": "Full replacement of an existing customer sales quote. Send the `If-Match` header with the current ETag for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "sales-quotes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Sales quote ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"RI\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"QUOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"validUntilDate\": \"\",\n \"proforma\": \"\",\n \"discountVoucherId\": \"\",\n \"autoIssueDiscountVoucher\": \"\",\n \"visitReasonId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "88419e0b-bcc1-488a-933d-11dbe5e09a6a", "name": "Sales quote updated", "originalRequest": { "url": { "path": [ "api", "v2", "sales-quotes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales quote ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"RI\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"QUOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"validUntilDate\": \"\",\n \"proforma\": \"\",\n \"discountVoucherId\": \"\",\n \"autoIssueDiscountVoucher\": \"\",\n \"visitReasonId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"documentType\": \"DELIVERY_NOTE\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"deliveryStatus\": \"P\",\n \"lifecycleStatus\": \"\",\n \"paymentStatus\": \"OVERPAID\",\n \"documentStatusId\": \"\",\n \"documentStatusName\": \"\",\n \"issued\": \"\",\n \"draft\": \"\",\n \"enabled\": \"\",\n \"verified\": \"\",\n \"documentDate\": \"\",\n \"shippingDate\": \"\",\n \"counterpartyName\": \"\",\n \"counterpartyTaxId\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"companyTaxId\": \"\",\n \"warehouseName\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"optometristId\": \"\",\n \"optometristName\": \"\",\n \"documentTypeId\": \"\",\n \"documentTypeName\": \"\",\n \"paymentTermsId\": \"\",\n \"paymentTermsName\": \"\",\n \"basePriceListId\": \"\",\n \"basePriceListName\": \"\",\n \"discountPriceListId\": \"\",\n \"discountPriceListName\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"withholdingTaxTypeName\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"totalQuantity\": \"\",\n \"grossAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"discountAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"specialDiscountPct\": \"\",\n \"specialDiscountAmount\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"earlyPaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatAmount\": \"\",\n \"surchargeEquivalencePct\": \"\",\n \"surchargeEquivalenceAmount\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"withholdingTaxAmount\": \"\",\n \"shippingAmount\": \"\",\n \"financingPct\": \"\",\n \"financingAmount\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"commercialTotalAmount\": \"\",\n \"total\": \"\",\n \"totalPaid\": \"\",\n \"outstandingAmount\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"currencyDecimals\": \"\",\n \"currencyDecimalsSystem\": \"\",\n \"exchangeRate\": \"\",\n \"grossAmountSystem\": \"\",\n \"discountAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"roundingMode\": \"\",\n \"relationConcept\": \"\",\n \"relationType\": \"\",\n \"linkableQuantity\": \"\",\n \"relationQuantity\": \"\",\n \"totalApprovals\": \"\",\n \"validatedApprovals\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"LOAD\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"RI\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"MC\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"grossAmount\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatPct\": \"\",\n \"vatAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"surchargePct\": \"\",\n \"surchargeAmount\": \"\",\n \"total\": \"\",\n \"commercialTotalAmount\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"id\": \"\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n },\n {\n \"type\": \"DISCOUNT\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n }\n ],\n \"appliedPriceRule\": {\n \"id\": \"\",\n \"ruleType\": \"DISCOUNT\",\n \"tariffId\": \"\",\n \"tariffName\": \"\",\n \"comboId\": \"\",\n \"comboName\": \"\",\n \"purchaseCondition\": \"\",\n \"purchaseConditionId\": \"\",\n \"discountConditionId\": \"\",\n \"discountValue\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ]\n },\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"grossAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"reservedQuantity\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"INVENTORY_TRANSFER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"opticalOrderId\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"grossAmount\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatPct\": \"\",\n \"vatAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"surchargePct\": \"\",\n \"surchargeAmount\": \"\",\n \"total\": \"\",\n \"commercialTotalAmount\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n },\n {\n \"type\": \"COMBO\",\n \"id\": \"\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n }\n ],\n \"appliedPriceRule\": {\n \"id\": \"\",\n \"ruleType\": \"COMBO\",\n \"tariffId\": \"\",\n \"tariffName\": \"\",\n \"comboId\": \"\",\n \"comboName\": \"\",\n \"purchaseCondition\": \"\",\n \"purchaseConditionId\": \"\",\n \"discountConditionId\": \"\",\n \"discountValue\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ]\n },\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"grossAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"reservedQuantity\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"OPTICAL_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"REPAIR_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"opticalOrderId\": \"\"\n }\n ],\n \"validUntilDate\": \"\",\n \"proforma\": \"\",\n \"discountVoucherId\": \"\",\n \"discountVoucherCode\": \"\",\n \"autoIssueDiscountVoucher\": \"\",\n \"visitReasonId\": \"\",\n \"visitReasonName\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3f6d6230-281c-4759-a767-8976e810c0e7", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-quotes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales quote ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"RI\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"QUOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"validUntilDate\": \"\",\n \"proforma\": \"\",\n \"discountVoucherId\": \"\",\n \"autoIssueDiscountVoucher\": \"\",\n \"visitReasonId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "611124ce-6a08-4a5a-abe4-d44d964610df", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "sales-quotes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales quote ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"RI\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"QUOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"validUntilDate\": \"\",\n \"proforma\": \"\",\n \"discountVoucherId\": \"\",\n \"autoIssueDiscountVoucher\": \"\",\n \"visitReasonId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "235b6b0c-ba6a-4eda-b122-6408ff24b1d6", "name": "Authenticated user is missing the `EDITAR_PRESUPUESTOSEMITIDOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "sales-quotes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales quote ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"RI\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"QUOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"validUntilDate\": \"\",\n \"proforma\": \"\",\n \"discountVoucherId\": \"\",\n \"autoIssueDiscountVoucher\": \"\",\n \"visitReasonId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "874abae2-9583-444a-9f53-041a89f63d7b", "name": "Sales quote not found", "originalRequest": { "url": { "path": [ "api", "v2", "sales-quotes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales quote ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"RI\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"QUOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"validUntilDate\": \"\",\n \"proforma\": \"\",\n \"discountVoucherId\": \"\",\n \"autoIssueDiscountVoucher\": \"\",\n \"visitReasonId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ffb2d07d-96d0-451b-a7d7-5a707f10ee0b", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-quotes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales quote ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"RI\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"QUOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"validUntilDate\": \"\",\n \"proforma\": \"\",\n \"discountVoucherId\": \"\",\n \"autoIssueDiscountVoucher\": \"\",\n \"visitReasonId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "271a252b-277f-4252-b046-2a41fd57a45b", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-quotes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales quote ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"RI\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"QUOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"validUntilDate\": \"\",\n \"proforma\": \"\",\n \"discountVoucherId\": \"\",\n \"autoIssueDiscountVoucher\": \"\",\n \"visitReasonId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8bf2ca0a-2421-43ef-a248-ec7bd57a7332", "name": "Delete sales quote", "request": { "name": "Delete sales quote", "description": { "content": "Deletes a customer sales quote. Send the `If-Match` header with the current ETag for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "sales-quotes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Sales quote ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "1107ca56-38cc-471c-b390-3a9a5f51df9b", "name": "Sales quote deleted", "originalRequest": { "url": { "path": [ "api", "v2", "sales-quotes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales quote ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8f233127-8cab-4654-8ac8-112e2b2a60b8", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "sales-quotes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales quote ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3e9bec42-4222-417a-bdbc-10ff2a133fc8", "name": "Authenticated user is missing the `BORRAR_PRESUPUESTOSEMITIDOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "sales-quotes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales quote ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fbac62b1-12a8-4884-b108-4449fa60a39a", "name": "Sales quote not found", "originalRequest": { "url": { "path": [ "api", "v2", "sales-quotes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales quote ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fcf13896-60a4-41d3-98a4-d27fc877edbd", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-quotes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales quote ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f1cc9aae-9178-47a9-8e10-ee01090b4db6", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-quotes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales quote ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0cee5665-4e48-4641-bb3f-acd173872680", "name": "Merge-patch sales quote", "request": { "name": "Merge-patch sales quote", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "sales-quotes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Sales quote ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "7805d337-9684-4a9a-a767-57d064fe2f45", "name": "Sales quote patched", "originalRequest": { "url": { "path": [ "api", "v2", "sales-quotes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales quote ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"documentType\": \"DELIVERY_NOTE\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"deliveryStatus\": \"P\",\n \"lifecycleStatus\": \"\",\n \"paymentStatus\": \"OVERPAID\",\n \"documentStatusId\": \"\",\n \"documentStatusName\": \"\",\n \"issued\": \"\",\n \"draft\": \"\",\n \"enabled\": \"\",\n \"verified\": \"\",\n \"documentDate\": \"\",\n \"shippingDate\": \"\",\n \"counterpartyName\": \"\",\n \"counterpartyTaxId\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"companyTaxId\": \"\",\n \"warehouseName\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"optometristId\": \"\",\n \"optometristName\": \"\",\n \"documentTypeId\": \"\",\n \"documentTypeName\": \"\",\n \"paymentTermsId\": \"\",\n \"paymentTermsName\": \"\",\n \"basePriceListId\": \"\",\n \"basePriceListName\": \"\",\n \"discountPriceListId\": \"\",\n \"discountPriceListName\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"withholdingTaxTypeName\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"totalQuantity\": \"\",\n \"grossAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"discountAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"specialDiscountPct\": \"\",\n \"specialDiscountAmount\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"earlyPaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatAmount\": \"\",\n \"surchargeEquivalencePct\": \"\",\n \"surchargeEquivalenceAmount\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"withholdingTaxAmount\": \"\",\n \"shippingAmount\": \"\",\n \"financingPct\": \"\",\n \"financingAmount\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"commercialTotalAmount\": \"\",\n \"total\": \"\",\n \"totalPaid\": \"\",\n \"outstandingAmount\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"currencyDecimals\": \"\",\n \"currencyDecimalsSystem\": \"\",\n \"exchangeRate\": \"\",\n \"grossAmountSystem\": \"\",\n \"discountAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"roundingMode\": \"\",\n \"relationConcept\": \"\",\n \"relationType\": \"\",\n \"linkableQuantity\": \"\",\n \"relationQuantity\": \"\",\n \"totalApprovals\": \"\",\n \"validatedApprovals\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"LOAD\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"RI\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"MC\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"grossAmount\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatPct\": \"\",\n \"vatAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"surchargePct\": \"\",\n \"surchargeAmount\": \"\",\n \"total\": \"\",\n \"commercialTotalAmount\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"id\": \"\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n },\n {\n \"type\": \"DISCOUNT\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n }\n ],\n \"appliedPriceRule\": {\n \"id\": \"\",\n \"ruleType\": \"DISCOUNT\",\n \"tariffId\": \"\",\n \"tariffName\": \"\",\n \"comboId\": \"\",\n \"comboName\": \"\",\n \"purchaseCondition\": \"\",\n \"purchaseConditionId\": \"\",\n \"discountConditionId\": \"\",\n \"discountValue\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ]\n },\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"grossAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"reservedQuantity\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"INVENTORY_TRANSFER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"opticalOrderId\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"grossAmount\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatPct\": \"\",\n \"vatAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"surchargePct\": \"\",\n \"surchargeAmount\": \"\",\n \"total\": \"\",\n \"commercialTotalAmount\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n },\n {\n \"type\": \"COMBO\",\n \"id\": \"\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n }\n ],\n \"appliedPriceRule\": {\n \"id\": \"\",\n \"ruleType\": \"COMBO\",\n \"tariffId\": \"\",\n \"tariffName\": \"\",\n \"comboId\": \"\",\n \"comboName\": \"\",\n \"purchaseCondition\": \"\",\n \"purchaseConditionId\": \"\",\n \"discountConditionId\": \"\",\n \"discountValue\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ]\n },\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"grossAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"reservedQuantity\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"OPTICAL_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"REPAIR_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"opticalOrderId\": \"\"\n }\n ],\n \"validUntilDate\": \"\",\n \"proforma\": \"\",\n \"discountVoucherId\": \"\",\n \"discountVoucherCode\": \"\",\n \"autoIssueDiscountVoucher\": \"\",\n \"visitReasonId\": \"\",\n \"visitReasonName\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "34bd50d6-e528-4dfa-ba99-d246a3ff8a98", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details. Also returned for malformed merge-patch payloads.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-quotes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales quote ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a6907aa5-5e2d-4922-9cc6-5b5251999100", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "sales-quotes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales quote ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5a73dcec-e8db-416c-8b19-f41a28fef346", "name": "Authenticated user is missing the `EDITAR_PRESUPUESTOSEMITIDOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "sales-quotes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales quote ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c00a98d7-ad06-4d5a-9e60-cbb59b08d0de", "name": "Sales quote not found", "originalRequest": { "url": { "path": [ "api", "v2", "sales-quotes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales quote ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4d4dc49f-649c-4ede-8f96-9303d2a219e3", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-quotes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales quote ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fbf22385-b27a-4e67-9af3-e1b0ed8f4f4c", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-quotes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales quote ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "e8fd8577-4988-4477-9c83-15c2a6b3b875", "name": "List sales quotes", "request": { "name": "List sales quotes", "description": { "content": "Returns a paginated list of customer sales quotes with envelope `{data, totalCount, skip, limit, hasMore}`. Supports optional RSQL `filter`, `sort` (default `lastModifiedAt:desc`), `skip`/`limit` pagination and `modifiedAfter`/`modifiedBefore` bookends. Limit is capped at 200; skip is clamped to >= 0.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "sales-quotes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "aed272c4-45b4-4ab8-a7b7-19835b8a4736", "name": "Page of sales quotes", "originalRequest": { "url": { "path": [ "api", "v2", "sales-quotes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b00dc90d-2188-4d60-8536-1337654eb0e7", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "sales-quotes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "818114b8-cf78-4569-96d7-942aa6caff32", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "sales-quotes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "11cb023e-05f6-4cd0-ac84-d302057c3a5c", "name": "Authenticated user is missing the `VER_PRESUPUESTOSEMITIDOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "sales-quotes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "49f550bb-51d2-457c-af18-d518a01fdfe6", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-quotes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4904938b-ebc2-4540-891f-0b573c0a6740", "name": "Create sales quote", "request": { "name": "Create sales quote", "description": { "content": "Creates a new customer sales quote with the provided data and optional line items and prepayments. Business logic runs in the legacy WAR via the internal commands gateway.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "sales-quotes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"RI\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"QUOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"validUntilDate\": \"\",\n \"proforma\": \"\",\n \"discountVoucherId\": \"\",\n \"autoIssueDiscountVoucher\": \"\",\n \"visitReasonId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "f031fc93-d057-40cb-bc68-4ea3c5ac6881", "name": "Sales quote created", "originalRequest": { "url": { "path": [ "api", "v2", "sales-quotes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"RI\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"QUOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"validUntilDate\": \"\",\n \"proforma\": \"\",\n \"discountVoucherId\": \"\",\n \"autoIssueDiscountVoucher\": \"\",\n \"visitReasonId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"documentType\": \"DELIVERY_NOTE\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"deliveryStatus\": \"P\",\n \"lifecycleStatus\": \"\",\n \"paymentStatus\": \"OVERPAID\",\n \"documentStatusId\": \"\",\n \"documentStatusName\": \"\",\n \"issued\": \"\",\n \"draft\": \"\",\n \"enabled\": \"\",\n \"verified\": \"\",\n \"documentDate\": \"\",\n \"shippingDate\": \"\",\n \"counterpartyName\": \"\",\n \"counterpartyTaxId\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"companyTaxId\": \"\",\n \"warehouseName\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"optometristId\": \"\",\n \"optometristName\": \"\",\n \"documentTypeId\": \"\",\n \"documentTypeName\": \"\",\n \"paymentTermsId\": \"\",\n \"paymentTermsName\": \"\",\n \"basePriceListId\": \"\",\n \"basePriceListName\": \"\",\n \"discountPriceListId\": \"\",\n \"discountPriceListName\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"withholdingTaxTypeName\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"totalQuantity\": \"\",\n \"grossAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"discountAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"specialDiscountPct\": \"\",\n \"specialDiscountAmount\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"earlyPaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatAmount\": \"\",\n \"surchargeEquivalencePct\": \"\",\n \"surchargeEquivalenceAmount\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"withholdingTaxAmount\": \"\",\n \"shippingAmount\": \"\",\n \"financingPct\": \"\",\n \"financingAmount\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"commercialTotalAmount\": \"\",\n \"total\": \"\",\n \"totalPaid\": \"\",\n \"outstandingAmount\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"currencyDecimals\": \"\",\n \"currencyDecimalsSystem\": \"\",\n \"exchangeRate\": \"\",\n \"grossAmountSystem\": \"\",\n \"discountAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"roundingMode\": \"\",\n \"relationConcept\": \"\",\n \"relationType\": \"\",\n \"linkableQuantity\": \"\",\n \"relationQuantity\": \"\",\n \"totalApprovals\": \"\",\n \"validatedApprovals\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"LOAD\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"RI\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"MC\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"grossAmount\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatPct\": \"\",\n \"vatAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"surchargePct\": \"\",\n \"surchargeAmount\": \"\",\n \"total\": \"\",\n \"commercialTotalAmount\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"id\": \"\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n },\n {\n \"type\": \"DISCOUNT\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n }\n ],\n \"appliedPriceRule\": {\n \"id\": \"\",\n \"ruleType\": \"DISCOUNT\",\n \"tariffId\": \"\",\n \"tariffName\": \"\",\n \"comboId\": \"\",\n \"comboName\": \"\",\n \"purchaseCondition\": \"\",\n \"purchaseConditionId\": \"\",\n \"discountConditionId\": \"\",\n \"discountValue\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ]\n },\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"grossAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"reservedQuantity\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"INVENTORY_TRANSFER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"opticalOrderId\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"grossAmount\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatPct\": \"\",\n \"vatAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"surchargePct\": \"\",\n \"surchargeAmount\": \"\",\n \"total\": \"\",\n \"commercialTotalAmount\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n },\n {\n \"type\": \"COMBO\",\n \"id\": \"\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n }\n ],\n \"appliedPriceRule\": {\n \"id\": \"\",\n \"ruleType\": \"COMBO\",\n \"tariffId\": \"\",\n \"tariffName\": \"\",\n \"comboId\": \"\",\n \"comboName\": \"\",\n \"purchaseCondition\": \"\",\n \"purchaseConditionId\": \"\",\n \"discountConditionId\": \"\",\n \"discountValue\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ]\n },\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"grossAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"reservedQuantity\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"OPTICAL_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"REPAIR_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"opticalOrderId\": \"\"\n }\n ],\n \"validUntilDate\": \"\",\n \"proforma\": \"\",\n \"discountVoucherId\": \"\",\n \"discountVoucherCode\": \"\",\n \"autoIssueDiscountVoucher\": \"\",\n \"visitReasonId\": \"\",\n \"visitReasonName\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5fd4fe74-b205-4b70-8bcb-48655c29bd6b", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-quotes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"RI\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"QUOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"validUntilDate\": \"\",\n \"proforma\": \"\",\n \"discountVoucherId\": \"\",\n \"autoIssueDiscountVoucher\": \"\",\n \"visitReasonId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "24d48634-b4b7-4173-a87c-5976e8ba0f27", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "sales-quotes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"RI\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"QUOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"validUntilDate\": \"\",\n \"proforma\": \"\",\n \"discountVoucherId\": \"\",\n \"autoIssueDiscountVoucher\": \"\",\n \"visitReasonId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "41240154-ec33-458c-b57d-e5c7f8b58ae3", "name": "Authenticated user is missing the `CREAR_PRESUPUESTOSEMITIDOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "sales-quotes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"RI\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"QUOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"validUntilDate\": \"\",\n \"proforma\": \"\",\n \"discountVoucherId\": \"\",\n \"autoIssueDiscountVoucher\": \"\",\n \"visitReasonId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "51a7f8af-bc84-418a-91f1-c83596bd2e6c", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-quotes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"RI\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"QUOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"validUntilDate\": \"\",\n \"proforma\": \"\",\n \"discountVoucherId\": \"\",\n \"autoIssueDiscountVoucher\": \"\",\n \"visitReasonId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "sales-orders", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "1b6fa4b7-3198-4ab6-a1bf-cd03d01db28a", "name": "Get sales order by ID", "request": { "name": "Get sales order by ID", "description": { "content": "Returns a single customer sales order by its primary key, including line items and payments. Listing (`GET` without id) returns headers only. The response carries a strong `ETag` header with the current version.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "sales-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Sales order ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "cae6a155-bdb6-4b83-90da-9a30082b07c7", "name": "Sales order found", "originalRequest": { "url": { "path": [ "api", "v2", "sales-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"documentType\": \"DELIVERY_NOTE\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"deliveryStatus\": \"EP\",\n \"lifecycleStatus\": \"\",\n \"paymentStatus\": \"PAID\",\n \"documentStatusId\": \"\",\n \"documentStatusName\": \"\",\n \"issued\": \"\",\n \"draft\": \"\",\n \"enabled\": \"\",\n \"verified\": \"\",\n \"documentDate\": \"\",\n \"shippingDate\": \"\",\n \"counterpartyName\": \"\",\n \"counterpartyTaxId\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"companyTaxId\": \"\",\n \"warehouseName\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"optometristId\": \"\",\n \"optometristName\": \"\",\n \"documentTypeId\": \"\",\n \"documentTypeName\": \"\",\n \"paymentTermsId\": \"\",\n \"paymentTermsName\": \"\",\n \"basePriceListId\": \"\",\n \"basePriceListName\": \"\",\n \"discountPriceListId\": \"\",\n \"discountPriceListName\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"withholdingTaxTypeName\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"totalQuantity\": \"\",\n \"grossAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"discountAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"specialDiscountPct\": \"\",\n \"specialDiscountAmount\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"earlyPaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatAmount\": \"\",\n \"surchargeEquivalencePct\": \"\",\n \"surchargeEquivalenceAmount\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"withholdingTaxAmount\": \"\",\n \"shippingAmount\": \"\",\n \"financingPct\": \"\",\n \"financingAmount\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"commercialTotalAmount\": \"\",\n \"total\": \"\",\n \"totalPaid\": \"\",\n \"outstandingAmount\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"currencyDecimals\": \"\",\n \"currencyDecimalsSystem\": \"\",\n \"exchangeRate\": \"\",\n \"grossAmountSystem\": \"\",\n \"discountAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"roundingMode\": \"\",\n \"relationConcept\": \"\",\n \"relationType\": \"\",\n \"linkableQuantity\": \"\",\n \"relationQuantity\": \"\",\n \"totalApprovals\": \"\",\n \"validatedApprovals\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"DELIVERY_NOTE\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"INVENTORY_TRANSFER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"C\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"MC\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"grossAmount\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatPct\": \"\",\n \"vatAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"surchargePct\": \"\",\n \"surchargeAmount\": \"\",\n \"total\": \"\",\n \"commercialTotalAmount\": \"\",\n \"discounts\": [\n {\n \"type\": \"INSURER\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n },\n {\n \"type\": \"POINTS\",\n \"id\": \"\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n }\n ],\n \"appliedPriceRule\": {\n \"id\": \"\",\n \"ruleType\": \"COMBO\",\n \"tariffId\": \"\",\n \"tariffName\": \"\",\n \"comboId\": \"\",\n \"comboName\": \"\",\n \"purchaseCondition\": \"\",\n \"purchaseConditionId\": \"\",\n \"discountConditionId\": \"\",\n \"discountValue\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ]\n },\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"grossAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"reservedQuantity\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"OPTICAL_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"opticalOrderId\": \"\",\n \"receivedQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"grossAmount\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatPct\": \"\",\n \"vatAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"surchargePct\": \"\",\n \"surchargeAmount\": \"\",\n \"total\": \"\",\n \"commercialTotalAmount\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"id\": \"\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n },\n {\n \"type\": \"DISCOUNT\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n }\n ],\n \"appliedPriceRule\": {\n \"id\": \"\",\n \"ruleType\": \"COMBO\",\n \"tariffId\": \"\",\n \"tariffName\": \"\",\n \"comboId\": \"\",\n \"comboName\": \"\",\n \"purchaseCondition\": \"\",\n \"purchaseConditionId\": \"\",\n \"discountConditionId\": \"\",\n \"discountValue\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ]\n },\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"grossAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"reservedQuantity\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"OPTICAL_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"INVOICE\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"opticalOrderId\": \"\",\n \"receivedQuantity\": \"\"\n }\n ],\n \"trackingCode\": \"\",\n \"subscription\": \"\",\n \"subscriptionOrderId\": \"\",\n \"manufacturingDate\": \"\",\n \"expiryDate\": \"\",\n \"finishedUnits\": \"\",\n \"soldOrder\": \"\",\n \"fabricationStatus\": \"\",\n \"lastFabricationStatusChange\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "666681a4-c9a8-4e78-b4ad-b4eb676bcccd", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "sales-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a9bde92e-1745-46c9-85b2-17c12bcfcd39", "name": "Authenticated user is missing the `VER_PEDIDOSCLIENTE` permission", "originalRequest": { "url": { "path": [ "api", "v2", "sales-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ac8cac0e-70c6-4940-889d-455467af0f3c", "name": "Sales order not found", "originalRequest": { "url": { "path": [ "api", "v2", "sales-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d1974f11-114e-4820-aff7-9024da732d94", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "efc24313-7249-48f6-8885-f28c01f4e836", "name": "Update sales order", "request": { "name": "Update sales order", "description": { "content": "Full replacement of an existing customer sales order. Send the `If-Match` header with the current ETag for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "sales-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Sales order ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXEMPT\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"PIN\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"trackingCode\": \"\",\n \"subscription\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "d0287e48-3a4c-4930-a5ac-3b489a07eff6", "name": "Sales order updated", "originalRequest": { "url": { "path": [ "api", "v2", "sales-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXEMPT\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"PIN\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"trackingCode\": \"\",\n \"subscription\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"documentType\": \"DELIVERY_NOTE\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"deliveryStatus\": \"EP\",\n \"lifecycleStatus\": \"\",\n \"paymentStatus\": \"PAID\",\n \"documentStatusId\": \"\",\n \"documentStatusName\": \"\",\n \"issued\": \"\",\n \"draft\": \"\",\n \"enabled\": \"\",\n \"verified\": \"\",\n \"documentDate\": \"\",\n \"shippingDate\": \"\",\n \"counterpartyName\": \"\",\n \"counterpartyTaxId\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"companyTaxId\": \"\",\n \"warehouseName\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"optometristId\": \"\",\n \"optometristName\": \"\",\n \"documentTypeId\": \"\",\n \"documentTypeName\": \"\",\n \"paymentTermsId\": \"\",\n \"paymentTermsName\": \"\",\n \"basePriceListId\": \"\",\n \"basePriceListName\": \"\",\n \"discountPriceListId\": \"\",\n \"discountPriceListName\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"withholdingTaxTypeName\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"totalQuantity\": \"\",\n \"grossAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"discountAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"specialDiscountPct\": \"\",\n \"specialDiscountAmount\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"earlyPaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatAmount\": \"\",\n \"surchargeEquivalencePct\": \"\",\n \"surchargeEquivalenceAmount\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"withholdingTaxAmount\": \"\",\n \"shippingAmount\": \"\",\n \"financingPct\": \"\",\n \"financingAmount\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"commercialTotalAmount\": \"\",\n \"total\": \"\",\n \"totalPaid\": \"\",\n \"outstandingAmount\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"currencyDecimals\": \"\",\n \"currencyDecimalsSystem\": \"\",\n \"exchangeRate\": \"\",\n \"grossAmountSystem\": \"\",\n \"discountAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"roundingMode\": \"\",\n \"relationConcept\": \"\",\n \"relationType\": \"\",\n \"linkableQuantity\": \"\",\n \"relationQuantity\": \"\",\n \"totalApprovals\": \"\",\n \"validatedApprovals\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"DELIVERY_NOTE\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"INVENTORY_TRANSFER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"C\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"MC\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"grossAmount\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatPct\": \"\",\n \"vatAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"surchargePct\": \"\",\n \"surchargeAmount\": \"\",\n \"total\": \"\",\n \"commercialTotalAmount\": \"\",\n \"discounts\": [\n {\n \"type\": \"INSURER\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n },\n {\n \"type\": \"POINTS\",\n \"id\": \"\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n }\n ],\n \"appliedPriceRule\": {\n \"id\": \"\",\n \"ruleType\": \"COMBO\",\n \"tariffId\": \"\",\n \"tariffName\": \"\",\n \"comboId\": \"\",\n \"comboName\": \"\",\n \"purchaseCondition\": \"\",\n \"purchaseConditionId\": \"\",\n \"discountConditionId\": \"\",\n \"discountValue\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ]\n },\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"grossAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"reservedQuantity\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"OPTICAL_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"opticalOrderId\": \"\",\n \"receivedQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"grossAmount\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatPct\": \"\",\n \"vatAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"surchargePct\": \"\",\n \"surchargeAmount\": \"\",\n \"total\": \"\",\n \"commercialTotalAmount\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"id\": \"\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n },\n {\n \"type\": \"DISCOUNT\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n }\n ],\n \"appliedPriceRule\": {\n \"id\": \"\",\n \"ruleType\": \"COMBO\",\n \"tariffId\": \"\",\n \"tariffName\": \"\",\n \"comboId\": \"\",\n \"comboName\": \"\",\n \"purchaseCondition\": \"\",\n \"purchaseConditionId\": \"\",\n \"discountConditionId\": \"\",\n \"discountValue\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ]\n },\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"grossAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"reservedQuantity\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"OPTICAL_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"INVOICE\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"opticalOrderId\": \"\",\n \"receivedQuantity\": \"\"\n }\n ],\n \"trackingCode\": \"\",\n \"subscription\": \"\",\n \"subscriptionOrderId\": \"\",\n \"manufacturingDate\": \"\",\n \"expiryDate\": \"\",\n \"finishedUnits\": \"\",\n \"soldOrder\": \"\",\n \"fabricationStatus\": \"\",\n \"lastFabricationStatusChange\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d3c97694-2962-49f2-aa3e-3be8a9dbaa4f", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXEMPT\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"PIN\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"trackingCode\": \"\",\n \"subscription\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ea2d2128-3d89-4780-b556-6d0caea5aba8", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "sales-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXEMPT\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"PIN\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"trackingCode\": \"\",\n \"subscription\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8557912d-4324-4385-9884-922bdb0f0f71", "name": "Authenticated user is missing the `EDITAR_PEDIDOSCLIENTE` permission", "originalRequest": { "url": { "path": [ "api", "v2", "sales-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXEMPT\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"PIN\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"trackingCode\": \"\",\n \"subscription\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "302eeb48-2362-4084-9b9a-fb4263579dd8", "name": "Sales order not found", "originalRequest": { "url": { "path": [ "api", "v2", "sales-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXEMPT\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"PIN\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"trackingCode\": \"\",\n \"subscription\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b930ad4a-5495-4508-b406-1fcbf10a0669", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXEMPT\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"PIN\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"trackingCode\": \"\",\n \"subscription\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "57997272-15d4-4aeb-9497-cb7875af1b82", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXEMPT\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"PIN\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"trackingCode\": \"\",\n \"subscription\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d3d5ec51-50a6-4fc9-a967-61a87fb00700", "name": "Delete sales order", "request": { "name": "Delete sales order", "description": { "content": "Deletes a customer sales order. Send the `If-Match` header with the current ETag for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "sales-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Sales order ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "9289e57c-82c0-4241-873e-3b67235b89da", "name": "Sales order deleted", "originalRequest": { "url": { "path": [ "api", "v2", "sales-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ac71129c-7771-403e-a77c-38454bca24d0", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "sales-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b3f6394b-39df-4a65-ba87-8031ee8c1036", "name": "Authenticated user is missing the `BORRAR_PEDIDOSCLIENTE` permission", "originalRequest": { "url": { "path": [ "api", "v2", "sales-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3afcb420-dfd5-4998-a16e-881f2645ab7d", "name": "Sales order not found", "originalRequest": { "url": { "path": [ "api", "v2", "sales-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "07366a9b-90a1-45e4-be12-0d910f7e4314", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d99ed51a-ae85-4342-aaba-f173b2725ee3", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "77d6f27c-edfe-4390-a747-dfd35545ae42", "name": "Merge-patch sales order", "request": { "name": "Merge-patch sales order", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "sales-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Sales order ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "1248e1f2-1a9f-4836-b2f2-74265c47fbb4", "name": "Sales order patched", "originalRequest": { "url": { "path": [ "api", "v2", "sales-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"documentType\": \"DELIVERY_NOTE\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"deliveryStatus\": \"EP\",\n \"lifecycleStatus\": \"\",\n \"paymentStatus\": \"PAID\",\n \"documentStatusId\": \"\",\n \"documentStatusName\": \"\",\n \"issued\": \"\",\n \"draft\": \"\",\n \"enabled\": \"\",\n \"verified\": \"\",\n \"documentDate\": \"\",\n \"shippingDate\": \"\",\n \"counterpartyName\": \"\",\n \"counterpartyTaxId\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"companyTaxId\": \"\",\n \"warehouseName\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"optometristId\": \"\",\n \"optometristName\": \"\",\n \"documentTypeId\": \"\",\n \"documentTypeName\": \"\",\n \"paymentTermsId\": \"\",\n \"paymentTermsName\": \"\",\n \"basePriceListId\": \"\",\n \"basePriceListName\": \"\",\n \"discountPriceListId\": \"\",\n \"discountPriceListName\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"withholdingTaxTypeName\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"totalQuantity\": \"\",\n \"grossAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"discountAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"specialDiscountPct\": \"\",\n \"specialDiscountAmount\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"earlyPaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatAmount\": \"\",\n \"surchargeEquivalencePct\": \"\",\n \"surchargeEquivalenceAmount\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"withholdingTaxAmount\": \"\",\n \"shippingAmount\": \"\",\n \"financingPct\": \"\",\n \"financingAmount\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"commercialTotalAmount\": \"\",\n \"total\": \"\",\n \"totalPaid\": \"\",\n \"outstandingAmount\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"currencyDecimals\": \"\",\n \"currencyDecimalsSystem\": \"\",\n \"exchangeRate\": \"\",\n \"grossAmountSystem\": \"\",\n \"discountAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"roundingMode\": \"\",\n \"relationConcept\": \"\",\n \"relationType\": \"\",\n \"linkableQuantity\": \"\",\n \"relationQuantity\": \"\",\n \"totalApprovals\": \"\",\n \"validatedApprovals\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"DELIVERY_NOTE\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"INVENTORY_TRANSFER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"C\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"MC\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"grossAmount\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatPct\": \"\",\n \"vatAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"surchargePct\": \"\",\n \"surchargeAmount\": \"\",\n \"total\": \"\",\n \"commercialTotalAmount\": \"\",\n \"discounts\": [\n {\n \"type\": \"INSURER\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n },\n {\n \"type\": \"POINTS\",\n \"id\": \"\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n }\n ],\n \"appliedPriceRule\": {\n \"id\": \"\",\n \"ruleType\": \"COMBO\",\n \"tariffId\": \"\",\n \"tariffName\": \"\",\n \"comboId\": \"\",\n \"comboName\": \"\",\n \"purchaseCondition\": \"\",\n \"purchaseConditionId\": \"\",\n \"discountConditionId\": \"\",\n \"discountValue\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ]\n },\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"grossAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"reservedQuantity\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"OPTICAL_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"opticalOrderId\": \"\",\n \"receivedQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"grossAmount\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatPct\": \"\",\n \"vatAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"surchargePct\": \"\",\n \"surchargeAmount\": \"\",\n \"total\": \"\",\n \"commercialTotalAmount\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"id\": \"\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n },\n {\n \"type\": \"DISCOUNT\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n }\n ],\n \"appliedPriceRule\": {\n \"id\": \"\",\n \"ruleType\": \"COMBO\",\n \"tariffId\": \"\",\n \"tariffName\": \"\",\n \"comboId\": \"\",\n \"comboName\": \"\",\n \"purchaseCondition\": \"\",\n \"purchaseConditionId\": \"\",\n \"discountConditionId\": \"\",\n \"discountValue\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ]\n },\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"grossAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"reservedQuantity\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"OPTICAL_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"INVOICE\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"opticalOrderId\": \"\",\n \"receivedQuantity\": \"\"\n }\n ],\n \"trackingCode\": \"\",\n \"subscription\": \"\",\n \"subscriptionOrderId\": \"\",\n \"manufacturingDate\": \"\",\n \"expiryDate\": \"\",\n \"finishedUnits\": \"\",\n \"soldOrder\": \"\",\n \"fabricationStatus\": \"\",\n \"lastFabricationStatusChange\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "981177bb-5da0-4362-9ec2-bee407a8199e", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details. Also returned for malformed merge-patch payloads.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0cb3e98d-52ff-4a87-adfb-71803bae024a", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "sales-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "dffe15a5-88d3-4d6d-9959-9b83fd5cea03", "name": "Authenticated user is missing the `EDITAR_PEDIDOSCLIENTE` permission", "originalRequest": { "url": { "path": [ "api", "v2", "sales-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "aa77e865-7d3d-46c4-ade0-66e45e992f65", "name": "Sales order not found", "originalRequest": { "url": { "path": [ "api", "v2", "sales-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a9b54eb3-63d8-4b92-b9bf-49ef06d4856f", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "51ca1afa-5d0a-4518-8884-6411374cbbeb", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "cd0c0ce9-63a3-4bbd-afc6-2d700ad4e700", "name": "List sales orders", "request": { "name": "List sales orders", "description": { "content": "Returns a paginated list of customer sales orders with envelope `{data, totalCount, skip, limit, hasMore}`. Supports optional RSQL `filter`, `sort` (default `lastModifiedAt:desc`), `skip`/`limit` pagination and `modifiedAfter`/`modifiedBefore` bookends. Limit is capped at 200; skip is clamped to >= 0.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "sales-orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "8eb93188-88f3-4102-bc74-dccfe42b6739", "name": "Page of sales orders", "originalRequest": { "url": { "path": [ "api", "v2", "sales-orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cd651106-ea2a-4778-892e-3e203d0c92ef", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "sales-orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5c2c10d0-eb0e-4c22-82fe-fabe36085478", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "sales-orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cf69d857-46fe-4f41-8827-a7792f24d631", "name": "Authenticated user is missing the `VER_PEDIDOSCLIENTE` permission", "originalRequest": { "url": { "path": [ "api", "v2", "sales-orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2264e289-dd30-4775-a6b4-e7052a99142b", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "52e857da-f905-4076-98a8-c58503d2336e", "name": "Create sales order", "request": { "name": "Create sales order", "description": { "content": "Creates a new customer sales order with the provided data and optional line items and payments. Business logic runs in the legacy WAR via the internal commands gateway.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "sales-orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXEMPT\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"PIN\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"trackingCode\": \"\",\n \"subscription\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "8c223925-06f2-4f59-9ee2-ac153cdc995b", "name": "Sales order created", "originalRequest": { "url": { "path": [ "api", "v2", "sales-orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXEMPT\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"PIN\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"trackingCode\": \"\",\n \"subscription\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"documentType\": \"DELIVERY_NOTE\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"deliveryStatus\": \"EP\",\n \"lifecycleStatus\": \"\",\n \"paymentStatus\": \"PAID\",\n \"documentStatusId\": \"\",\n \"documentStatusName\": \"\",\n \"issued\": \"\",\n \"draft\": \"\",\n \"enabled\": \"\",\n \"verified\": \"\",\n \"documentDate\": \"\",\n \"shippingDate\": \"\",\n \"counterpartyName\": \"\",\n \"counterpartyTaxId\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"companyTaxId\": \"\",\n \"warehouseName\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"optometristId\": \"\",\n \"optometristName\": \"\",\n \"documentTypeId\": \"\",\n \"documentTypeName\": \"\",\n \"paymentTermsId\": \"\",\n \"paymentTermsName\": \"\",\n \"basePriceListId\": \"\",\n \"basePriceListName\": \"\",\n \"discountPriceListId\": \"\",\n \"discountPriceListName\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"withholdingTaxTypeName\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"totalQuantity\": \"\",\n \"grossAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"discountAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"specialDiscountPct\": \"\",\n \"specialDiscountAmount\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"earlyPaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatAmount\": \"\",\n \"surchargeEquivalencePct\": \"\",\n \"surchargeEquivalenceAmount\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"withholdingTaxAmount\": \"\",\n \"shippingAmount\": \"\",\n \"financingPct\": \"\",\n \"financingAmount\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"commercialTotalAmount\": \"\",\n \"total\": \"\",\n \"totalPaid\": \"\",\n \"outstandingAmount\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"currencyDecimals\": \"\",\n \"currencyDecimalsSystem\": \"\",\n \"exchangeRate\": \"\",\n \"grossAmountSystem\": \"\",\n \"discountAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"roundingMode\": \"\",\n \"relationConcept\": \"\",\n \"relationType\": \"\",\n \"linkableQuantity\": \"\",\n \"relationQuantity\": \"\",\n \"totalApprovals\": \"\",\n \"validatedApprovals\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"DELIVERY_NOTE\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"INVENTORY_TRANSFER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"C\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"MC\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"grossAmount\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatPct\": \"\",\n \"vatAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"surchargePct\": \"\",\n \"surchargeAmount\": \"\",\n \"total\": \"\",\n \"commercialTotalAmount\": \"\",\n \"discounts\": [\n {\n \"type\": \"INSURER\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n },\n {\n \"type\": \"POINTS\",\n \"id\": \"\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n }\n ],\n \"appliedPriceRule\": {\n \"id\": \"\",\n \"ruleType\": \"COMBO\",\n \"tariffId\": \"\",\n \"tariffName\": \"\",\n \"comboId\": \"\",\n \"comboName\": \"\",\n \"purchaseCondition\": \"\",\n \"purchaseConditionId\": \"\",\n \"discountConditionId\": \"\",\n \"discountValue\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ]\n },\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"grossAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"reservedQuantity\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"OPTICAL_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"opticalOrderId\": \"\",\n \"receivedQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"grossAmount\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatPct\": \"\",\n \"vatAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"surchargePct\": \"\",\n \"surchargeAmount\": \"\",\n \"total\": \"\",\n \"commercialTotalAmount\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"id\": \"\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n },\n {\n \"type\": \"DISCOUNT\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n }\n ],\n \"appliedPriceRule\": {\n \"id\": \"\",\n \"ruleType\": \"COMBO\",\n \"tariffId\": \"\",\n \"tariffName\": \"\",\n \"comboId\": \"\",\n \"comboName\": \"\",\n \"purchaseCondition\": \"\",\n \"purchaseConditionId\": \"\",\n \"discountConditionId\": \"\",\n \"discountValue\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ]\n },\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"grossAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"reservedQuantity\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"OPTICAL_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"INVOICE\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"opticalOrderId\": \"\",\n \"receivedQuantity\": \"\"\n }\n ],\n \"trackingCode\": \"\",\n \"subscription\": \"\",\n \"subscriptionOrderId\": \"\",\n \"manufacturingDate\": \"\",\n \"expiryDate\": \"\",\n \"finishedUnits\": \"\",\n \"soldOrder\": \"\",\n \"fabricationStatus\": \"\",\n \"lastFabricationStatusChange\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c66b2d7d-8d99-408c-a5c5-0960f5a294a9", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXEMPT\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"PIN\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"trackingCode\": \"\",\n \"subscription\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d9c84406-9ac4-4cd7-8a9d-9598d709571b", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "sales-orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXEMPT\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"PIN\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"trackingCode\": \"\",\n \"subscription\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2e857c7e-2244-4a5f-b51c-6b890a179803", "name": "Authenticated user is missing the `CREAR_PEDIDOSCLIENTE` permission", "originalRequest": { "url": { "path": [ "api", "v2", "sales-orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXEMPT\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"PIN\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"trackingCode\": \"\",\n \"subscription\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "653d97e6-62d7-4898-8b3a-32ff510675a9", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXEMPT\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"PIN\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"trackingCode\": \"\",\n \"subscription\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "sales-invoices", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "b2bbd414-dc63-49bd-a896-04f10137d2ee", "name": "Get sales invoice by ID", "request": { "name": "Get sales invoice by ID", "description": { "content": "Returns a single customer sales invoice by its primary key. The response carries a strong `ETag` header with the current version for optimistic concurrency control. Returns 404 when the requested ID belongs to a purchase (issued=false) document. Honours `If-None-Match`: when the supplied ETag matches the current version on the server, the endpoint returns `304 Not Modified` without loading the full invoice detail graph.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "sales-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Sales invoice ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Conditional GET: send the ETag from a previous response (e.g. `\"3\"`) to ask the server to skip the body when nothing has changed. If the supplied version matches the current entity version the endpoint returns `304 Not Modified` with the ETag header and no body ÔÇö the SQL load for the detail graph is skipped entirely. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted, plus the wildcard `*` which matches any current version.", "type": "text/plain" }, "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "908e1a3f-1daf-4b76-90fe-f44c9485139b", "name": "Sales invoice found", "originalRequest": { "url": { "path": [ "api", "v2", "sales-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales invoice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Conditional GET: send the ETag from a previous response (e.g. `\"3\"`) to ask the server to skip the body when nothing has changed. If the supplied version matches the current entity version the endpoint returns `304 Not Modified` with the ETag header and no body ÔÇö the SQL load for the detail graph is skipped entirely. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted, plus the wildcard `*` which matches any current version.", "type": "text/plain" }, "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"counterpartyId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"grossAmount\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatPct\": \"\",\n \"vatAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"surchargePct\": \"\",\n \"surchargeAmount\": \"\",\n \"total\": \"\",\n \"commercialTotalAmount\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n }\n ],\n \"appliedPriceRule\": {\n \"id\": \"\",\n \"ruleType\": \"COMBO\",\n \"tariffId\": \"\",\n \"tariffName\": \"\",\n \"comboId\": \"\",\n \"comboName\": \"\",\n \"purchaseCondition\": \"\",\n \"purchaseConditionId\": \"\",\n \"discountConditionId\": \"\",\n \"discountValue\": \"\",\n \"categoryIds\": [\n \"\"\n ]\n },\n \"excludedTariffIds\": [\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"grossAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"reservedQuantity\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"PURCHASE_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"opticalOrderId\": \"\",\n \"deliveryStatus\": \"\",\n \"sunatUnitOfMeasure\": \"NIU\"\n }\n ],\n \"warehouseId\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"documentType\": \"INVOICE\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"deliveryStatus\": \"EP\",\n \"lifecycleStatus\": \"\",\n \"paymentStatus\": \"UNPAID\",\n \"documentStatusId\": \"\",\n \"documentStatusName\": \"\",\n \"issued\": \"\",\n \"draft\": \"\",\n \"enabled\": \"\",\n \"verified\": \"\",\n \"documentDate\": \"\",\n \"shippingDate\": \"\",\n \"counterpartyName\": \"\",\n \"counterpartyTaxId\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"companyTaxId\": \"\",\n \"warehouseName\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"optometristId\": \"\",\n \"optometristName\": \"\",\n \"documentTypeId\": \"\",\n \"documentTypeName\": \"\",\n \"paymentTermsId\": \"\",\n \"paymentTermsName\": \"\",\n \"basePriceListId\": \"\",\n \"basePriceListName\": \"\",\n \"discountPriceListId\": \"\",\n \"discountPriceListName\": \"\",\n \"taxBehavior\": \"EXEMPT\",\n \"withholdingTaxTypeId\": \"\",\n \"withholdingTaxTypeName\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"totalQuantity\": \"\",\n \"grossAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"discountAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"specialDiscountPct\": \"\",\n \"specialDiscountAmount\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"earlyPaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatAmount\": \"\",\n \"surchargeEquivalencePct\": \"\",\n \"surchargeEquivalenceAmount\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"withholdingTaxAmount\": \"\",\n \"shippingAmount\": \"\",\n \"financingPct\": \"\",\n \"financingAmount\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"commercialTotalAmount\": \"\",\n \"total\": \"\",\n \"totalPaid\": \"\",\n \"outstandingAmount\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"currencyDecimals\": \"\",\n \"currencyDecimalsSystem\": \"\",\n \"exchangeRate\": \"\",\n \"grossAmountSystem\": \"\",\n \"discountAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"roundingMode\": \"\",\n \"relationConcept\": \"\",\n \"relationType\": \"\",\n \"linkableQuantity\": \"\",\n \"relationQuantity\": \"\",\n \"totalApprovals\": \"\",\n \"validatedApprovals\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"QUOTE\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"RI\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"pricesIncludeTax\": \"\",\n \"generateDeliveryNote\": \"\",\n \"issueDate\": \"\",\n \"accountingDate\": \"\",\n \"receptionDate\": \"\",\n \"counterpartyType\": \"CC\",\n \"totalWithholdings\": \"\",\n \"accountingNumber\": \"\",\n \"journalEntryId\": \"\",\n \"accountingLedger\": \"\",\n \"linkedToAccounting\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"withholdingTaxAccountId\": \"\",\n \"withholdingTaxAccountName\": \"\",\n \"activityId\": \"\",\n \"activityName\": \"\",\n \"invoiceType\": \"SUB\",\n \"simplified\": \"\",\n \"creditNoteType\": \"\",\n \"saleCondition\": \"\",\n \"reverseCharge\": \"\",\n \"intraCommunity\": \"\",\n \"insuranceInvoice\": \"\",\n \"visitReasonId\": \"\",\n \"visitReasonName\": \"\",\n \"primaryInsurerId\": \"\",\n \"primaryInsurerName\": \"\",\n \"secondaryInsurerId\": \"\",\n \"secondaryInsurerName\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"tertiaryInsurerName\": \"\",\n \"primaryContractNumber\": \"\",\n \"secondaryContractNumber\": \"\",\n \"tertiaryContractNumber\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insuredPartyId\": \"\",\n \"insuredPartyName\": \"\",\n \"insuredNationalId\": \"\",\n \"insuredPolicyNumber\": \"\",\n \"insuredClaimNumber\": \"\",\n \"pointsWalletId\": \"\",\n \"pointsWalletToRedeemId\": \"\",\n \"customerPointsBalance\": \"\",\n \"pointsEarned\": \"\",\n \"pointsRedeemed\": \"\",\n \"pointsValueAmount\": \"\",\n \"opticalDataId\": \"\",\n \"discountPinId\": \"\",\n \"claimId\": \"\",\n \"installments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"dueDate\": \"\",\n \"paid\": \"\",\n \"issued\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"paymentId\": \"\",\n \"withholdingLineId\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"withholdingTaxPct\": \"\"\n }\n ],\n \"totalInstallments\": \"\",\n \"paidInstallments\": \"\",\n \"electronicInvoice\": {\n \"id\": \"\",\n \"signStatus\": \"SUBMIT_ERROR\",\n \"signedAt\": \"\",\n \"lastSignErrorCode\": \"\",\n \"lastSignErrorMessage\": \"\",\n \"sunatHash\": \"\",\n \"sunatInvoiceCode\": \"\",\n \"sunatQrCode\": \"\",\n \"dgiCufe\": \"\",\n \"dgiAuthorizationNumber\": \"\",\n \"dgiSecNumber\": \"\",\n \"dgiDv\": \"\",\n \"dgiQrCode\": \"\",\n \"dgiSystemRef\": \"\"\n },\n \"verifactuStatus\": \"\",\n \"verifactuReady\": \"\",\n \"cfdiUsage\": \"\",\n \"satPaymentMethod\": \"\",\n \"cancellationRecordId\": \"\",\n \"folioNumber\": \"\",\n \"establishmentCode\": \"\",\n \"emissionPointCode\": \"\",\n \"authorizationCode\": \"\",\n \"global\": \"\",\n \"globalInvoiceId\": \"\",\n \"fiscalDocumentNumber\": \"\",\n \"fiscalPrinterSerial\": \"\",\n \"sunatPaymentMethod\": \"CO\",\n \"capabilities\": {\n \"header\": {\n \"allowed\": \"\",\n \"code\": \"VERIFACTU_STATE\",\n \"reason\": \"\"\n },\n \"counterparty\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"documentDate\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"internalFields\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"amounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"unitPrices\": {\n \"allowed\": \"\",\n \"code\": \"VERIFACTU_STATE\",\n \"reason\": \"\"\n },\n \"manualDiscounts\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"lineDescriptions\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"products\": {\n \"allowed\": \"\",\n \"code\": \"VERIFACTU_STATE\",\n \"reason\": \"\"\n },\n \"quantities\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"accounting\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"payments\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"insurerAmounts\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"costCenters\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"opticalOrders\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"edit\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"delete\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n }\n },\n \"einvoiceError\": \"\",\n \"einvoiceXmlUrl\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "706386b5-1858-443d-82a6-a1f053da1da2", "name": "Not Modified ÔÇö the client's `If-None-Match` ETag matches the current version", "originalRequest": { "url": { "path": [ "api", "v2", "sales-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales invoice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Conditional GET: send the ETag from a previous response (e.g. `\"3\"`) to ask the server to skip the body when nothing has changed. If the supplied version matches the current entity version the endpoint returns `304 Not Modified` with the ETag header and no body ÔÇö the SQL load for the detail graph is skipped entirely. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted, plus the wildcard `*` which matches any current version.", "type": "text/plain" }, "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Modified", "code": 304, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"counterpartyId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"grossAmount\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatPct\": \"\",\n \"vatAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"surchargePct\": \"\",\n \"surchargeAmount\": \"\",\n \"total\": \"\",\n \"commercialTotalAmount\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n }\n ],\n \"appliedPriceRule\": {\n \"id\": \"\",\n \"ruleType\": \"COMBO\",\n \"tariffId\": \"\",\n \"tariffName\": \"\",\n \"comboId\": \"\",\n \"comboName\": \"\",\n \"purchaseCondition\": \"\",\n \"purchaseConditionId\": \"\",\n \"discountConditionId\": \"\",\n \"discountValue\": \"\",\n \"categoryIds\": [\n \"\"\n ]\n },\n \"excludedTariffIds\": [\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"grossAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"reservedQuantity\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"PURCHASE_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"opticalOrderId\": \"\",\n \"deliveryStatus\": \"\",\n \"sunatUnitOfMeasure\": \"NIU\"\n }\n ],\n \"warehouseId\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"documentType\": \"INVOICE\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"deliveryStatus\": \"EP\",\n \"lifecycleStatus\": \"\",\n \"paymentStatus\": \"UNPAID\",\n \"documentStatusId\": \"\",\n \"documentStatusName\": \"\",\n \"issued\": \"\",\n \"draft\": \"\",\n \"enabled\": \"\",\n \"verified\": \"\",\n \"documentDate\": \"\",\n \"shippingDate\": \"\",\n \"counterpartyName\": \"\",\n \"counterpartyTaxId\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"companyTaxId\": \"\",\n \"warehouseName\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"optometristId\": \"\",\n \"optometristName\": \"\",\n \"documentTypeId\": \"\",\n \"documentTypeName\": \"\",\n \"paymentTermsId\": \"\",\n \"paymentTermsName\": \"\",\n \"basePriceListId\": \"\",\n \"basePriceListName\": \"\",\n \"discountPriceListId\": \"\",\n \"discountPriceListName\": \"\",\n \"taxBehavior\": \"EXEMPT\",\n \"withholdingTaxTypeId\": \"\",\n \"withholdingTaxTypeName\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"totalQuantity\": \"\",\n \"grossAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"discountAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"specialDiscountPct\": \"\",\n \"specialDiscountAmount\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"earlyPaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatAmount\": \"\",\n \"surchargeEquivalencePct\": \"\",\n \"surchargeEquivalenceAmount\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"withholdingTaxAmount\": \"\",\n \"shippingAmount\": \"\",\n \"financingPct\": \"\",\n \"financingAmount\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"commercialTotalAmount\": \"\",\n \"total\": \"\",\n \"totalPaid\": \"\",\n \"outstandingAmount\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"currencyDecimals\": \"\",\n \"currencyDecimalsSystem\": \"\",\n \"exchangeRate\": \"\",\n \"grossAmountSystem\": \"\",\n \"discountAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"roundingMode\": \"\",\n \"relationConcept\": \"\",\n \"relationType\": \"\",\n \"linkableQuantity\": \"\",\n \"relationQuantity\": \"\",\n \"totalApprovals\": \"\",\n \"validatedApprovals\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"QUOTE\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"RI\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"pricesIncludeTax\": \"\",\n \"generateDeliveryNote\": \"\",\n \"issueDate\": \"\",\n \"accountingDate\": \"\",\n \"receptionDate\": \"\",\n \"counterpartyType\": \"CC\",\n \"totalWithholdings\": \"\",\n \"accountingNumber\": \"\",\n \"journalEntryId\": \"\",\n \"accountingLedger\": \"\",\n \"linkedToAccounting\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"withholdingTaxAccountId\": \"\",\n \"withholdingTaxAccountName\": \"\",\n \"activityId\": \"\",\n \"activityName\": \"\",\n \"invoiceType\": \"SUB\",\n \"simplified\": \"\",\n \"creditNoteType\": \"\",\n \"saleCondition\": \"\",\n \"reverseCharge\": \"\",\n \"intraCommunity\": \"\",\n \"insuranceInvoice\": \"\",\n \"visitReasonId\": \"\",\n \"visitReasonName\": \"\",\n \"primaryInsurerId\": \"\",\n \"primaryInsurerName\": \"\",\n \"secondaryInsurerId\": \"\",\n \"secondaryInsurerName\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"tertiaryInsurerName\": \"\",\n \"primaryContractNumber\": \"\",\n \"secondaryContractNumber\": \"\",\n \"tertiaryContractNumber\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insuredPartyId\": \"\",\n \"insuredPartyName\": \"\",\n \"insuredNationalId\": \"\",\n \"insuredPolicyNumber\": \"\",\n \"insuredClaimNumber\": \"\",\n \"pointsWalletId\": \"\",\n \"pointsWalletToRedeemId\": \"\",\n \"customerPointsBalance\": \"\",\n \"pointsEarned\": \"\",\n \"pointsRedeemed\": \"\",\n \"pointsValueAmount\": \"\",\n \"opticalDataId\": \"\",\n \"discountPinId\": \"\",\n \"claimId\": \"\",\n \"installments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"dueDate\": \"\",\n \"paid\": \"\",\n \"issued\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"paymentId\": \"\",\n \"withholdingLineId\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"withholdingTaxPct\": \"\"\n }\n ],\n \"totalInstallments\": \"\",\n \"paidInstallments\": \"\",\n \"electronicInvoice\": {\n \"id\": \"\",\n \"signStatus\": \"SUBMIT_ERROR\",\n \"signedAt\": \"\",\n \"lastSignErrorCode\": \"\",\n \"lastSignErrorMessage\": \"\",\n \"sunatHash\": \"\",\n \"sunatInvoiceCode\": \"\",\n \"sunatQrCode\": \"\",\n \"dgiCufe\": \"\",\n \"dgiAuthorizationNumber\": \"\",\n \"dgiSecNumber\": \"\",\n \"dgiDv\": \"\",\n \"dgiQrCode\": \"\",\n \"dgiSystemRef\": \"\"\n },\n \"verifactuStatus\": \"\",\n \"verifactuReady\": \"\",\n \"cfdiUsage\": \"\",\n \"satPaymentMethod\": \"\",\n \"cancellationRecordId\": \"\",\n \"folioNumber\": \"\",\n \"establishmentCode\": \"\",\n \"emissionPointCode\": \"\",\n \"authorizationCode\": \"\",\n \"global\": \"\",\n \"globalInvoiceId\": \"\",\n \"fiscalDocumentNumber\": \"\",\n \"fiscalPrinterSerial\": \"\",\n \"sunatPaymentMethod\": \"CO\",\n \"capabilities\": {\n \"header\": {\n \"allowed\": \"\",\n \"code\": \"VERIFACTU_STATE\",\n \"reason\": \"\"\n },\n \"counterparty\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"documentDate\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"internalFields\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"amounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"unitPrices\": {\n \"allowed\": \"\",\n \"code\": \"VERIFACTU_STATE\",\n \"reason\": \"\"\n },\n \"manualDiscounts\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"lineDescriptions\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"products\": {\n \"allowed\": \"\",\n \"code\": \"VERIFACTU_STATE\",\n \"reason\": \"\"\n },\n \"quantities\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"accounting\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"payments\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"insurerAmounts\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"costCenters\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"opticalOrders\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"edit\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"delete\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n }\n },\n \"einvoiceError\": \"\",\n \"einvoiceXmlUrl\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "11304166-575a-45d9-b4af-1d84edd9a0fc", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "sales-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales invoice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Conditional GET: send the ETag from a previous response (e.g. `\"3\"`) to ask the server to skip the body when nothing has changed. If the supplied version matches the current entity version the endpoint returns `304 Not Modified` with the ETag header and no body ÔÇö the SQL load for the detail graph is skipped entirely. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted, plus the wildcard `*` which matches any current version.", "type": "text/plain" }, "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "655d90ef-8864-4a40-976d-a3c4dbab91a6", "name": "Authenticated user is missing the `VER_FACTURASEMITIDAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "sales-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales invoice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Conditional GET: send the ETag from a previous response (e.g. `\"3\"`) to ask the server to skip the body when nothing has changed. If the supplied version matches the current entity version the endpoint returns `304 Not Modified` with the ETag header and no body ÔÇö the SQL load for the detail graph is skipped entirely. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted, plus the wildcard `*` which matches any current version.", "type": "text/plain" }, "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "632618a0-3234-40b6-a1d2-a2a07c9d1145", "name": "Sales invoice not found", "originalRequest": { "url": { "path": [ "api", "v2", "sales-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales invoice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Conditional GET: send the ETag from a previous response (e.g. `\"3\"`) to ask the server to skip the body when nothing has changed. If the supplied version matches the current entity version the endpoint returns `304 Not Modified` with the ETag header and no body ÔÇö the SQL load for the detail graph is skipped entirely. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted, plus the wildcard `*` which matches any current version.", "type": "text/plain" }, "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f000de17-ca6b-41d5-a00e-bc89e3efbf90", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales invoice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Conditional GET: send the ETag from a previous response (e.g. `\"3\"`) to ask the server to skip the body when nothing has changed. If the supplied version matches the current entity version the endpoint returns `304 Not Modified` with the ETag header and no body ÔÇö the SQL load for the detail graph is skipped entirely. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted, plus the wildcard `*` which matches any current version.", "type": "text/plain" }, "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bb0beaf9-f37e-44a7-b02f-3ca02b089aa3", "name": "Update sales invoice", "request": { "name": "Update sales invoice", "description": { "content": "Full replacement of an existing customer sales invoice. Send the `If-Match` header with the current ETag for optimistic concurrency control. The `issued` flag is forced to `true` server-side. Returns 404 when the requested ID belongs to a purchase document.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "sales-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Sales invoice ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"POINTS\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\",\n \"sunatUnitOfMeasure\": \"NIU\"\n }\n ],\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"pricesIncludeTax\": \"\",\n \"generateDeliveryNote\": \"\",\n \"issueDate\": \"\",\n \"accountingDate\": \"\",\n \"receptionDate\": \"\",\n \"counterpartyType\": \"MS\",\n \"accountingLedger\": \"\",\n \"linkedToAccounting\": \"\",\n \"counterpartyAccountId\": \"\",\n \"withholdingTaxAccountId\": \"\",\n \"activityId\": \"\",\n \"simplified\": \"\",\n \"saleCondition\": \"\",\n \"reverseCharge\": \"\",\n \"intraCommunity\": \"\",\n \"insuranceInvoice\": \"\",\n \"visitReasonId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryContractNumber\": \"\",\n \"secondaryContractNumber\": \"\",\n \"tertiaryContractNumber\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insuredPartyId\": \"\",\n \"insuredNationalId\": \"\",\n \"insuredPolicyNumber\": \"\",\n \"insuredClaimNumber\": \"\",\n \"pointsWalletToRedeemId\": \"\",\n \"pointsToRedeem\": \"\",\n \"discountPinId\": \"\",\n \"installments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n }\n ],\n \"electronicInvoice\": {\n \"signStatus\": \"RECEIVED_PENDING\",\n \"signedAt\": \"\",\n \"lastSignErrorCode\": \"\",\n \"lastSignErrorMessage\": \"\",\n \"sunatHash\": \"\",\n \"sunatInvoiceCode\": \"\",\n \"sunatQrCode\": \"\",\n \"dgiCufe\": \"\",\n \"dgiAuthorizationNumber\": \"\",\n \"dgiSecNumber\": \"\",\n \"dgiDv\": \"\",\n \"dgiQrCode\": \"\",\n \"dgiSystemRef\": \"\"\n },\n \"sunatPaymentMethod\": \"CR\",\n \"capabilities\": {\n \"header\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"counterparty\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"documentDate\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"internalFields\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"amounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"unitPrices\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"manualDiscounts\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"lineDescriptions\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"products\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"quantities\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"accounting\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"payments\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"insurerAmounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"costCenters\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"opticalOrders\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"edit\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"delete\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n }\n },\n \"einvoiceError\": \"\",\n \"einvoiceXmlUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "b10138af-b2c3-488a-8152-5d42bd11a4b0", "name": "Sales invoice updated", "originalRequest": { "url": { "path": [ "api", "v2", "sales-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales invoice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"POINTS\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\",\n \"sunatUnitOfMeasure\": \"NIU\"\n }\n ],\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"pricesIncludeTax\": \"\",\n \"generateDeliveryNote\": \"\",\n \"issueDate\": \"\",\n \"accountingDate\": \"\",\n \"receptionDate\": \"\",\n \"counterpartyType\": \"MS\",\n \"accountingLedger\": \"\",\n \"linkedToAccounting\": \"\",\n \"counterpartyAccountId\": \"\",\n \"withholdingTaxAccountId\": \"\",\n \"activityId\": \"\",\n \"simplified\": \"\",\n \"saleCondition\": \"\",\n \"reverseCharge\": \"\",\n \"intraCommunity\": \"\",\n \"insuranceInvoice\": \"\",\n \"visitReasonId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryContractNumber\": \"\",\n \"secondaryContractNumber\": \"\",\n \"tertiaryContractNumber\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insuredPartyId\": \"\",\n \"insuredNationalId\": \"\",\n \"insuredPolicyNumber\": \"\",\n \"insuredClaimNumber\": \"\",\n \"pointsWalletToRedeemId\": \"\",\n \"pointsToRedeem\": \"\",\n \"discountPinId\": \"\",\n \"installments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n }\n ],\n \"electronicInvoice\": {\n \"signStatus\": \"RECEIVED_PENDING\",\n \"signedAt\": \"\",\n \"lastSignErrorCode\": \"\",\n \"lastSignErrorMessage\": \"\",\n \"sunatHash\": \"\",\n \"sunatInvoiceCode\": \"\",\n \"sunatQrCode\": \"\",\n \"dgiCufe\": \"\",\n \"dgiAuthorizationNumber\": \"\",\n \"dgiSecNumber\": \"\",\n \"dgiDv\": \"\",\n \"dgiQrCode\": \"\",\n \"dgiSystemRef\": \"\"\n },\n \"sunatPaymentMethod\": \"CR\",\n \"capabilities\": {\n \"header\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"counterparty\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"documentDate\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"internalFields\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"amounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"unitPrices\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"manualDiscounts\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"lineDescriptions\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"products\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"quantities\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"accounting\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"payments\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"insurerAmounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"costCenters\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"opticalOrders\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"edit\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"delete\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n }\n },\n \"einvoiceError\": \"\",\n \"einvoiceXmlUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"counterpartyId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"grossAmount\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatPct\": \"\",\n \"vatAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"surchargePct\": \"\",\n \"surchargeAmount\": \"\",\n \"total\": \"\",\n \"commercialTotalAmount\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n }\n ],\n \"appliedPriceRule\": {\n \"id\": \"\",\n \"ruleType\": \"COMBO\",\n \"tariffId\": \"\",\n \"tariffName\": \"\",\n \"comboId\": \"\",\n \"comboName\": \"\",\n \"purchaseCondition\": \"\",\n \"purchaseConditionId\": \"\",\n \"discountConditionId\": \"\",\n \"discountValue\": \"\",\n \"categoryIds\": [\n \"\"\n ]\n },\n \"excludedTariffIds\": [\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"grossAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"reservedQuantity\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"PURCHASE_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"opticalOrderId\": \"\",\n \"deliveryStatus\": \"\",\n \"sunatUnitOfMeasure\": \"NIU\"\n }\n ],\n \"warehouseId\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"documentType\": \"INVOICE\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"deliveryStatus\": \"EP\",\n \"lifecycleStatus\": \"\",\n \"paymentStatus\": \"UNPAID\",\n \"documentStatusId\": \"\",\n \"documentStatusName\": \"\",\n \"issued\": \"\",\n \"draft\": \"\",\n \"enabled\": \"\",\n \"verified\": \"\",\n \"documentDate\": \"\",\n \"shippingDate\": \"\",\n \"counterpartyName\": \"\",\n \"counterpartyTaxId\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"companyTaxId\": \"\",\n \"warehouseName\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"optometristId\": \"\",\n \"optometristName\": \"\",\n \"documentTypeId\": \"\",\n \"documentTypeName\": \"\",\n \"paymentTermsId\": \"\",\n \"paymentTermsName\": \"\",\n \"basePriceListId\": \"\",\n \"basePriceListName\": \"\",\n \"discountPriceListId\": \"\",\n \"discountPriceListName\": \"\",\n \"taxBehavior\": \"EXEMPT\",\n \"withholdingTaxTypeId\": \"\",\n \"withholdingTaxTypeName\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"totalQuantity\": \"\",\n \"grossAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"discountAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"specialDiscountPct\": \"\",\n \"specialDiscountAmount\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"earlyPaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatAmount\": \"\",\n \"surchargeEquivalencePct\": \"\",\n \"surchargeEquivalenceAmount\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"withholdingTaxAmount\": \"\",\n \"shippingAmount\": \"\",\n \"financingPct\": \"\",\n \"financingAmount\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"commercialTotalAmount\": \"\",\n \"total\": \"\",\n \"totalPaid\": \"\",\n \"outstandingAmount\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"currencyDecimals\": \"\",\n \"currencyDecimalsSystem\": \"\",\n \"exchangeRate\": \"\",\n \"grossAmountSystem\": \"\",\n \"discountAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"roundingMode\": \"\",\n \"relationConcept\": \"\",\n \"relationType\": \"\",\n \"linkableQuantity\": \"\",\n \"relationQuantity\": \"\",\n \"totalApprovals\": \"\",\n \"validatedApprovals\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"QUOTE\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"RI\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"pricesIncludeTax\": \"\",\n \"generateDeliveryNote\": \"\",\n \"issueDate\": \"\",\n \"accountingDate\": \"\",\n \"receptionDate\": \"\",\n \"counterpartyType\": \"CC\",\n \"totalWithholdings\": \"\",\n \"accountingNumber\": \"\",\n \"journalEntryId\": \"\",\n \"accountingLedger\": \"\",\n \"linkedToAccounting\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"withholdingTaxAccountId\": \"\",\n \"withholdingTaxAccountName\": \"\",\n \"activityId\": \"\",\n \"activityName\": \"\",\n \"invoiceType\": \"SUB\",\n \"simplified\": \"\",\n \"creditNoteType\": \"\",\n \"saleCondition\": \"\",\n \"reverseCharge\": \"\",\n \"intraCommunity\": \"\",\n \"insuranceInvoice\": \"\",\n \"visitReasonId\": \"\",\n \"visitReasonName\": \"\",\n \"primaryInsurerId\": \"\",\n \"primaryInsurerName\": \"\",\n \"secondaryInsurerId\": \"\",\n \"secondaryInsurerName\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"tertiaryInsurerName\": \"\",\n \"primaryContractNumber\": \"\",\n \"secondaryContractNumber\": \"\",\n \"tertiaryContractNumber\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insuredPartyId\": \"\",\n \"insuredPartyName\": \"\",\n \"insuredNationalId\": \"\",\n \"insuredPolicyNumber\": \"\",\n \"insuredClaimNumber\": \"\",\n \"pointsWalletId\": \"\",\n \"pointsWalletToRedeemId\": \"\",\n \"customerPointsBalance\": \"\",\n \"pointsEarned\": \"\",\n \"pointsRedeemed\": \"\",\n \"pointsValueAmount\": \"\",\n \"opticalDataId\": \"\",\n \"discountPinId\": \"\",\n \"claimId\": \"\",\n \"installments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"dueDate\": \"\",\n \"paid\": \"\",\n \"issued\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"paymentId\": \"\",\n \"withholdingLineId\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"withholdingTaxPct\": \"\"\n }\n ],\n \"totalInstallments\": \"\",\n \"paidInstallments\": \"\",\n \"electronicInvoice\": {\n \"id\": \"\",\n \"signStatus\": \"SUBMIT_ERROR\",\n \"signedAt\": \"\",\n \"lastSignErrorCode\": \"\",\n \"lastSignErrorMessage\": \"\",\n \"sunatHash\": \"\",\n \"sunatInvoiceCode\": \"\",\n \"sunatQrCode\": \"\",\n \"dgiCufe\": \"\",\n \"dgiAuthorizationNumber\": \"\",\n \"dgiSecNumber\": \"\",\n \"dgiDv\": \"\",\n \"dgiQrCode\": \"\",\n \"dgiSystemRef\": \"\"\n },\n \"verifactuStatus\": \"\",\n \"verifactuReady\": \"\",\n \"cfdiUsage\": \"\",\n \"satPaymentMethod\": \"\",\n \"cancellationRecordId\": \"\",\n \"folioNumber\": \"\",\n \"establishmentCode\": \"\",\n \"emissionPointCode\": \"\",\n \"authorizationCode\": \"\",\n \"global\": \"\",\n \"globalInvoiceId\": \"\",\n \"fiscalDocumentNumber\": \"\",\n \"fiscalPrinterSerial\": \"\",\n \"sunatPaymentMethod\": \"CO\",\n \"capabilities\": {\n \"header\": {\n \"allowed\": \"\",\n \"code\": \"VERIFACTU_STATE\",\n \"reason\": \"\"\n },\n \"counterparty\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"documentDate\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"internalFields\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"amounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"unitPrices\": {\n \"allowed\": \"\",\n \"code\": \"VERIFACTU_STATE\",\n \"reason\": \"\"\n },\n \"manualDiscounts\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"lineDescriptions\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"products\": {\n \"allowed\": \"\",\n \"code\": \"VERIFACTU_STATE\",\n \"reason\": \"\"\n },\n \"quantities\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"accounting\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"payments\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"insurerAmounts\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"costCenters\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"opticalOrders\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"edit\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"delete\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n }\n },\n \"einvoiceError\": \"\",\n \"einvoiceXmlUrl\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ed032a50-663c-40c6-87bc-ae3ff2f67240", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales invoice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"POINTS\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\",\n \"sunatUnitOfMeasure\": \"NIU\"\n }\n ],\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"pricesIncludeTax\": \"\",\n \"generateDeliveryNote\": \"\",\n \"issueDate\": \"\",\n \"accountingDate\": \"\",\n \"receptionDate\": \"\",\n \"counterpartyType\": \"MS\",\n \"accountingLedger\": \"\",\n \"linkedToAccounting\": \"\",\n \"counterpartyAccountId\": \"\",\n \"withholdingTaxAccountId\": \"\",\n \"activityId\": \"\",\n \"simplified\": \"\",\n \"saleCondition\": \"\",\n \"reverseCharge\": \"\",\n \"intraCommunity\": \"\",\n \"insuranceInvoice\": \"\",\n \"visitReasonId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryContractNumber\": \"\",\n \"secondaryContractNumber\": \"\",\n \"tertiaryContractNumber\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insuredPartyId\": \"\",\n \"insuredNationalId\": \"\",\n \"insuredPolicyNumber\": \"\",\n \"insuredClaimNumber\": \"\",\n \"pointsWalletToRedeemId\": \"\",\n \"pointsToRedeem\": \"\",\n \"discountPinId\": \"\",\n \"installments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n }\n ],\n \"electronicInvoice\": {\n \"signStatus\": \"RECEIVED_PENDING\",\n \"signedAt\": \"\",\n \"lastSignErrorCode\": \"\",\n \"lastSignErrorMessage\": \"\",\n \"sunatHash\": \"\",\n \"sunatInvoiceCode\": \"\",\n \"sunatQrCode\": \"\",\n \"dgiCufe\": \"\",\n \"dgiAuthorizationNumber\": \"\",\n \"dgiSecNumber\": \"\",\n \"dgiDv\": \"\",\n \"dgiQrCode\": \"\",\n \"dgiSystemRef\": \"\"\n },\n \"sunatPaymentMethod\": \"CR\",\n \"capabilities\": {\n \"header\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"counterparty\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"documentDate\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"internalFields\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"amounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"unitPrices\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"manualDiscounts\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"lineDescriptions\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"products\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"quantities\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"accounting\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"payments\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"insurerAmounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"costCenters\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"opticalOrders\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"edit\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"delete\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n }\n },\n \"einvoiceError\": \"\",\n \"einvoiceXmlUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5539eb91-92be-4b1c-b46a-da3e50b6e327", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "sales-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales invoice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"POINTS\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\",\n \"sunatUnitOfMeasure\": \"NIU\"\n }\n ],\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"pricesIncludeTax\": \"\",\n \"generateDeliveryNote\": \"\",\n \"issueDate\": \"\",\n \"accountingDate\": \"\",\n \"receptionDate\": \"\",\n \"counterpartyType\": \"MS\",\n \"accountingLedger\": \"\",\n \"linkedToAccounting\": \"\",\n \"counterpartyAccountId\": \"\",\n \"withholdingTaxAccountId\": \"\",\n \"activityId\": \"\",\n \"simplified\": \"\",\n \"saleCondition\": \"\",\n \"reverseCharge\": \"\",\n \"intraCommunity\": \"\",\n \"insuranceInvoice\": \"\",\n \"visitReasonId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryContractNumber\": \"\",\n \"secondaryContractNumber\": \"\",\n \"tertiaryContractNumber\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insuredPartyId\": \"\",\n \"insuredNationalId\": \"\",\n \"insuredPolicyNumber\": \"\",\n \"insuredClaimNumber\": \"\",\n \"pointsWalletToRedeemId\": \"\",\n \"pointsToRedeem\": \"\",\n \"discountPinId\": \"\",\n \"installments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n }\n ],\n \"electronicInvoice\": {\n \"signStatus\": \"RECEIVED_PENDING\",\n \"signedAt\": \"\",\n \"lastSignErrorCode\": \"\",\n \"lastSignErrorMessage\": \"\",\n \"sunatHash\": \"\",\n \"sunatInvoiceCode\": \"\",\n \"sunatQrCode\": \"\",\n \"dgiCufe\": \"\",\n \"dgiAuthorizationNumber\": \"\",\n \"dgiSecNumber\": \"\",\n \"dgiDv\": \"\",\n \"dgiQrCode\": \"\",\n \"dgiSystemRef\": \"\"\n },\n \"sunatPaymentMethod\": \"CR\",\n \"capabilities\": {\n \"header\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"counterparty\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"documentDate\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"internalFields\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"amounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"unitPrices\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"manualDiscounts\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"lineDescriptions\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"products\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"quantities\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"accounting\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"payments\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"insurerAmounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"costCenters\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"opticalOrders\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"edit\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"delete\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n }\n },\n \"einvoiceError\": \"\",\n \"einvoiceXmlUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "83edc71b-2cd9-4622-8945-d4bbd23e4bbc", "name": "Authenticated user is missing the `EDITAR_FACTURASEMITIDAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "sales-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales invoice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"POINTS\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\",\n \"sunatUnitOfMeasure\": \"NIU\"\n }\n ],\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"pricesIncludeTax\": \"\",\n \"generateDeliveryNote\": \"\",\n \"issueDate\": \"\",\n \"accountingDate\": \"\",\n \"receptionDate\": \"\",\n \"counterpartyType\": \"MS\",\n \"accountingLedger\": \"\",\n \"linkedToAccounting\": \"\",\n \"counterpartyAccountId\": \"\",\n \"withholdingTaxAccountId\": \"\",\n \"activityId\": \"\",\n \"simplified\": \"\",\n \"saleCondition\": \"\",\n \"reverseCharge\": \"\",\n \"intraCommunity\": \"\",\n \"insuranceInvoice\": \"\",\n \"visitReasonId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryContractNumber\": \"\",\n \"secondaryContractNumber\": \"\",\n \"tertiaryContractNumber\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insuredPartyId\": \"\",\n \"insuredNationalId\": \"\",\n \"insuredPolicyNumber\": \"\",\n \"insuredClaimNumber\": \"\",\n \"pointsWalletToRedeemId\": \"\",\n \"pointsToRedeem\": \"\",\n \"discountPinId\": \"\",\n \"installments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n }\n ],\n \"electronicInvoice\": {\n \"signStatus\": \"RECEIVED_PENDING\",\n \"signedAt\": \"\",\n \"lastSignErrorCode\": \"\",\n \"lastSignErrorMessage\": \"\",\n \"sunatHash\": \"\",\n \"sunatInvoiceCode\": \"\",\n \"sunatQrCode\": \"\",\n \"dgiCufe\": \"\",\n \"dgiAuthorizationNumber\": \"\",\n \"dgiSecNumber\": \"\",\n \"dgiDv\": \"\",\n \"dgiQrCode\": \"\",\n \"dgiSystemRef\": \"\"\n },\n \"sunatPaymentMethod\": \"CR\",\n \"capabilities\": {\n \"header\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"counterparty\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"documentDate\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"internalFields\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"amounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"unitPrices\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"manualDiscounts\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"lineDescriptions\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"products\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"quantities\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"accounting\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"payments\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"insurerAmounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"costCenters\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"opticalOrders\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"edit\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"delete\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n }\n },\n \"einvoiceError\": \"\",\n \"einvoiceXmlUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0936251c-0931-42f4-9082-7dcf8ca8e626", "name": "Sales invoice not found", "originalRequest": { "url": { "path": [ "api", "v2", "sales-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales invoice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"POINTS\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\",\n \"sunatUnitOfMeasure\": \"NIU\"\n }\n ],\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"pricesIncludeTax\": \"\",\n \"generateDeliveryNote\": \"\",\n \"issueDate\": \"\",\n \"accountingDate\": \"\",\n \"receptionDate\": \"\",\n \"counterpartyType\": \"MS\",\n \"accountingLedger\": \"\",\n \"linkedToAccounting\": \"\",\n \"counterpartyAccountId\": \"\",\n \"withholdingTaxAccountId\": \"\",\n \"activityId\": \"\",\n \"simplified\": \"\",\n \"saleCondition\": \"\",\n \"reverseCharge\": \"\",\n \"intraCommunity\": \"\",\n \"insuranceInvoice\": \"\",\n \"visitReasonId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryContractNumber\": \"\",\n \"secondaryContractNumber\": \"\",\n \"tertiaryContractNumber\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insuredPartyId\": \"\",\n \"insuredNationalId\": \"\",\n \"insuredPolicyNumber\": \"\",\n \"insuredClaimNumber\": \"\",\n \"pointsWalletToRedeemId\": \"\",\n \"pointsToRedeem\": \"\",\n \"discountPinId\": \"\",\n \"installments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n }\n ],\n \"electronicInvoice\": {\n \"signStatus\": \"RECEIVED_PENDING\",\n \"signedAt\": \"\",\n \"lastSignErrorCode\": \"\",\n \"lastSignErrorMessage\": \"\",\n \"sunatHash\": \"\",\n \"sunatInvoiceCode\": \"\",\n \"sunatQrCode\": \"\",\n \"dgiCufe\": \"\",\n \"dgiAuthorizationNumber\": \"\",\n \"dgiSecNumber\": \"\",\n \"dgiDv\": \"\",\n \"dgiQrCode\": \"\",\n \"dgiSystemRef\": \"\"\n },\n \"sunatPaymentMethod\": \"CR\",\n \"capabilities\": {\n \"header\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"counterparty\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"documentDate\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"internalFields\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"amounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"unitPrices\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"manualDiscounts\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"lineDescriptions\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"products\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"quantities\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"accounting\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"payments\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"insurerAmounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"costCenters\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"opticalOrders\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"edit\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"delete\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n }\n },\n \"einvoiceError\": \"\",\n \"einvoiceXmlUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a4aef2e4-4052-461a-b766-739deaa39ed4", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales invoice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"POINTS\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\",\n \"sunatUnitOfMeasure\": \"NIU\"\n }\n ],\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"pricesIncludeTax\": \"\",\n \"generateDeliveryNote\": \"\",\n \"issueDate\": \"\",\n \"accountingDate\": \"\",\n \"receptionDate\": \"\",\n \"counterpartyType\": \"MS\",\n \"accountingLedger\": \"\",\n \"linkedToAccounting\": \"\",\n \"counterpartyAccountId\": \"\",\n \"withholdingTaxAccountId\": \"\",\n \"activityId\": \"\",\n \"simplified\": \"\",\n \"saleCondition\": \"\",\n \"reverseCharge\": \"\",\n \"intraCommunity\": \"\",\n \"insuranceInvoice\": \"\",\n \"visitReasonId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryContractNumber\": \"\",\n \"secondaryContractNumber\": \"\",\n \"tertiaryContractNumber\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insuredPartyId\": \"\",\n \"insuredNationalId\": \"\",\n \"insuredPolicyNumber\": \"\",\n \"insuredClaimNumber\": \"\",\n \"pointsWalletToRedeemId\": \"\",\n \"pointsToRedeem\": \"\",\n \"discountPinId\": \"\",\n \"installments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n }\n ],\n \"electronicInvoice\": {\n \"signStatus\": \"RECEIVED_PENDING\",\n \"signedAt\": \"\",\n \"lastSignErrorCode\": \"\",\n \"lastSignErrorMessage\": \"\",\n \"sunatHash\": \"\",\n \"sunatInvoiceCode\": \"\",\n \"sunatQrCode\": \"\",\n \"dgiCufe\": \"\",\n \"dgiAuthorizationNumber\": \"\",\n \"dgiSecNumber\": \"\",\n \"dgiDv\": \"\",\n \"dgiQrCode\": \"\",\n \"dgiSystemRef\": \"\"\n },\n \"sunatPaymentMethod\": \"CR\",\n \"capabilities\": {\n \"header\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"counterparty\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"documentDate\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"internalFields\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"amounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"unitPrices\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"manualDiscounts\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"lineDescriptions\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"products\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"quantities\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"accounting\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"payments\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"insurerAmounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"costCenters\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"opticalOrders\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"edit\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"delete\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n }\n },\n \"einvoiceError\": \"\",\n \"einvoiceXmlUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c36c0d6e-f770-40e0-ae6c-a20039abbc81", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales invoice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"POINTS\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\",\n \"sunatUnitOfMeasure\": \"NIU\"\n }\n ],\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"pricesIncludeTax\": \"\",\n \"generateDeliveryNote\": \"\",\n \"issueDate\": \"\",\n \"accountingDate\": \"\",\n \"receptionDate\": \"\",\n \"counterpartyType\": \"MS\",\n \"accountingLedger\": \"\",\n \"linkedToAccounting\": \"\",\n \"counterpartyAccountId\": \"\",\n \"withholdingTaxAccountId\": \"\",\n \"activityId\": \"\",\n \"simplified\": \"\",\n \"saleCondition\": \"\",\n \"reverseCharge\": \"\",\n \"intraCommunity\": \"\",\n \"insuranceInvoice\": \"\",\n \"visitReasonId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryContractNumber\": \"\",\n \"secondaryContractNumber\": \"\",\n \"tertiaryContractNumber\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insuredPartyId\": \"\",\n \"insuredNationalId\": \"\",\n \"insuredPolicyNumber\": \"\",\n \"insuredClaimNumber\": \"\",\n \"pointsWalletToRedeemId\": \"\",\n \"pointsToRedeem\": \"\",\n \"discountPinId\": \"\",\n \"installments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n }\n ],\n \"electronicInvoice\": {\n \"signStatus\": \"RECEIVED_PENDING\",\n \"signedAt\": \"\",\n \"lastSignErrorCode\": \"\",\n \"lastSignErrorMessage\": \"\",\n \"sunatHash\": \"\",\n \"sunatInvoiceCode\": \"\",\n \"sunatQrCode\": \"\",\n \"dgiCufe\": \"\",\n \"dgiAuthorizationNumber\": \"\",\n \"dgiSecNumber\": \"\",\n \"dgiDv\": \"\",\n \"dgiQrCode\": \"\",\n \"dgiSystemRef\": \"\"\n },\n \"sunatPaymentMethod\": \"CR\",\n \"capabilities\": {\n \"header\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"counterparty\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"documentDate\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"internalFields\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"amounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"unitPrices\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"manualDiscounts\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"lineDescriptions\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"products\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"quantities\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"accounting\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"payments\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"insurerAmounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"costCenters\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"opticalOrders\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"edit\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"delete\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n }\n },\n \"einvoiceError\": \"\",\n \"einvoiceXmlUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7df0ddae-9cad-4397-9118-0deda0cd2ec0", "name": "Delete sales invoice", "request": { "name": "Delete sales invoice", "description": { "content": "Deletes a customer sales invoice. Send the `If-Match` header with the current ETag for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "sales-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Sales invoice ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "756560d6-fb72-4f6a-81b5-7518ec1b7330", "name": "Sales invoice deleted", "originalRequest": { "url": { "path": [ "api", "v2", "sales-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales invoice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e729cdef-6078-4032-a797-8ae0b02e81b6", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "sales-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales invoice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b57d2222-7ac2-416b-bedb-44ac421ae822", "name": "Authenticated user is missing the `BORRAR_FACTURASEMITIDAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "sales-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales invoice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c877103d-2bb9-4a54-9da3-9351424c374f", "name": "Sales invoice not found", "originalRequest": { "url": { "path": [ "api", "v2", "sales-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales invoice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e54edd19-4098-4a45-894f-7adf24c87898", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales invoice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fb7de987-bac4-4a0c-b152-8acd9a2977ef", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales invoice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0b6fb3cf-8715-4edc-9369-d8a62eba8c02", "name": "Merge-patch sales invoice", "request": { "name": "Merge-patch sales invoice", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "sales-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Sales invoice ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "8d8bac39-ae26-4c69-bc6d-64ef7cf14d91", "name": "Sales invoice patched", "originalRequest": { "url": { "path": [ "api", "v2", "sales-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales invoice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"counterpartyId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"grossAmount\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatPct\": \"\",\n \"vatAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"surchargePct\": \"\",\n \"surchargeAmount\": \"\",\n \"total\": \"\",\n \"commercialTotalAmount\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n }\n ],\n \"appliedPriceRule\": {\n \"id\": \"\",\n \"ruleType\": \"COMBO\",\n \"tariffId\": \"\",\n \"tariffName\": \"\",\n \"comboId\": \"\",\n \"comboName\": \"\",\n \"purchaseCondition\": \"\",\n \"purchaseConditionId\": \"\",\n \"discountConditionId\": \"\",\n \"discountValue\": \"\",\n \"categoryIds\": [\n \"\"\n ]\n },\n \"excludedTariffIds\": [\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"grossAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"reservedQuantity\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"PURCHASE_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"opticalOrderId\": \"\",\n \"deliveryStatus\": \"\",\n \"sunatUnitOfMeasure\": \"NIU\"\n }\n ],\n \"warehouseId\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"documentType\": \"INVOICE\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"deliveryStatus\": \"EP\",\n \"lifecycleStatus\": \"\",\n \"paymentStatus\": \"UNPAID\",\n \"documentStatusId\": \"\",\n \"documentStatusName\": \"\",\n \"issued\": \"\",\n \"draft\": \"\",\n \"enabled\": \"\",\n \"verified\": \"\",\n \"documentDate\": \"\",\n \"shippingDate\": \"\",\n \"counterpartyName\": \"\",\n \"counterpartyTaxId\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"companyTaxId\": \"\",\n \"warehouseName\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"optometristId\": \"\",\n \"optometristName\": \"\",\n \"documentTypeId\": \"\",\n \"documentTypeName\": \"\",\n \"paymentTermsId\": \"\",\n \"paymentTermsName\": \"\",\n \"basePriceListId\": \"\",\n \"basePriceListName\": \"\",\n \"discountPriceListId\": \"\",\n \"discountPriceListName\": \"\",\n \"taxBehavior\": \"EXEMPT\",\n \"withholdingTaxTypeId\": \"\",\n \"withholdingTaxTypeName\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"totalQuantity\": \"\",\n \"grossAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"discountAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"specialDiscountPct\": \"\",\n \"specialDiscountAmount\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"earlyPaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatAmount\": \"\",\n \"surchargeEquivalencePct\": \"\",\n \"surchargeEquivalenceAmount\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"withholdingTaxAmount\": \"\",\n \"shippingAmount\": \"\",\n \"financingPct\": \"\",\n \"financingAmount\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"commercialTotalAmount\": \"\",\n \"total\": \"\",\n \"totalPaid\": \"\",\n \"outstandingAmount\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"currencyDecimals\": \"\",\n \"currencyDecimalsSystem\": \"\",\n \"exchangeRate\": \"\",\n \"grossAmountSystem\": \"\",\n \"discountAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"roundingMode\": \"\",\n \"relationConcept\": \"\",\n \"relationType\": \"\",\n \"linkableQuantity\": \"\",\n \"relationQuantity\": \"\",\n \"totalApprovals\": \"\",\n \"validatedApprovals\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"QUOTE\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"RI\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"pricesIncludeTax\": \"\",\n \"generateDeliveryNote\": \"\",\n \"issueDate\": \"\",\n \"accountingDate\": \"\",\n \"receptionDate\": \"\",\n \"counterpartyType\": \"CC\",\n \"totalWithholdings\": \"\",\n \"accountingNumber\": \"\",\n \"journalEntryId\": \"\",\n \"accountingLedger\": \"\",\n \"linkedToAccounting\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"withholdingTaxAccountId\": \"\",\n \"withholdingTaxAccountName\": \"\",\n \"activityId\": \"\",\n \"activityName\": \"\",\n \"invoiceType\": \"SUB\",\n \"simplified\": \"\",\n \"creditNoteType\": \"\",\n \"saleCondition\": \"\",\n \"reverseCharge\": \"\",\n \"intraCommunity\": \"\",\n \"insuranceInvoice\": \"\",\n \"visitReasonId\": \"\",\n \"visitReasonName\": \"\",\n \"primaryInsurerId\": \"\",\n \"primaryInsurerName\": \"\",\n \"secondaryInsurerId\": \"\",\n \"secondaryInsurerName\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"tertiaryInsurerName\": \"\",\n \"primaryContractNumber\": \"\",\n \"secondaryContractNumber\": \"\",\n \"tertiaryContractNumber\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insuredPartyId\": \"\",\n \"insuredPartyName\": \"\",\n \"insuredNationalId\": \"\",\n \"insuredPolicyNumber\": \"\",\n \"insuredClaimNumber\": \"\",\n \"pointsWalletId\": \"\",\n \"pointsWalletToRedeemId\": \"\",\n \"customerPointsBalance\": \"\",\n \"pointsEarned\": \"\",\n \"pointsRedeemed\": \"\",\n \"pointsValueAmount\": \"\",\n \"opticalDataId\": \"\",\n \"discountPinId\": \"\",\n \"claimId\": \"\",\n \"installments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"dueDate\": \"\",\n \"paid\": \"\",\n \"issued\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"paymentId\": \"\",\n \"withholdingLineId\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"withholdingTaxPct\": \"\"\n }\n ],\n \"totalInstallments\": \"\",\n \"paidInstallments\": \"\",\n \"electronicInvoice\": {\n \"id\": \"\",\n \"signStatus\": \"SUBMIT_ERROR\",\n \"signedAt\": \"\",\n \"lastSignErrorCode\": \"\",\n \"lastSignErrorMessage\": \"\",\n \"sunatHash\": \"\",\n \"sunatInvoiceCode\": \"\",\n \"sunatQrCode\": \"\",\n \"dgiCufe\": \"\",\n \"dgiAuthorizationNumber\": \"\",\n \"dgiSecNumber\": \"\",\n \"dgiDv\": \"\",\n \"dgiQrCode\": \"\",\n \"dgiSystemRef\": \"\"\n },\n \"verifactuStatus\": \"\",\n \"verifactuReady\": \"\",\n \"cfdiUsage\": \"\",\n \"satPaymentMethod\": \"\",\n \"cancellationRecordId\": \"\",\n \"folioNumber\": \"\",\n \"establishmentCode\": \"\",\n \"emissionPointCode\": \"\",\n \"authorizationCode\": \"\",\n \"global\": \"\",\n \"globalInvoiceId\": \"\",\n \"fiscalDocumentNumber\": \"\",\n \"fiscalPrinterSerial\": \"\",\n \"sunatPaymentMethod\": \"CO\",\n \"capabilities\": {\n \"header\": {\n \"allowed\": \"\",\n \"code\": \"VERIFACTU_STATE\",\n \"reason\": \"\"\n },\n \"counterparty\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"documentDate\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"internalFields\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"amounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"unitPrices\": {\n \"allowed\": \"\",\n \"code\": \"VERIFACTU_STATE\",\n \"reason\": \"\"\n },\n \"manualDiscounts\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"lineDescriptions\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"products\": {\n \"allowed\": \"\",\n \"code\": \"VERIFACTU_STATE\",\n \"reason\": \"\"\n },\n \"quantities\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"accounting\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"payments\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"insurerAmounts\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"costCenters\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"opticalOrders\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"edit\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"delete\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n }\n },\n \"einvoiceError\": \"\",\n \"einvoiceXmlUrl\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d7704fbc-04ce-4e32-aa0f-2662d1bf2bc2", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details. Also returned for malformed merge-patch payloads.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales invoice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "654eb3b8-3804-429c-a473-09ad3d1562d7", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "sales-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales invoice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c0414cc9-80ab-4e68-a7ed-e048c9e3c99f", "name": "Authenticated user is missing the `EDITAR_FACTURASEMITIDAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "sales-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales invoice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "eb52a0ee-3d4d-4f31-9139-74718f449620", "name": "Sales invoice not found", "originalRequest": { "url": { "path": [ "api", "v2", "sales-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales invoice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "953796d3-6e0a-48b7-a2ed-b4be387b829e", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales invoice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e8faa99e-361c-42a5-a974-5c6c18aba6a4", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales invoice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "capabilities", "description": "", "item": [ { "id": "400c60e2-52a0-4d82-b533-ec605de08f41", "name": "Get sales invoice editability matrix", "request": { "name": "Get sales invoice editability matrix", "description": { "content": "Returns the server-resolved editability matrix for the invoice: which field groups (header, counterparty, amounts, unit prices, manual discounts, products, quantities, accounting, payments, insurer amounts, cost centers) and actions (edit, delete) are allowed for the current document state and the authenticated user's permissions, with a stable `code` and human-readable `reason` for every denied entry. Mirrors the legacy JSF lock/permission rules (TipoBloqueo, Verifactu lifecycle, OLA mode, Venezuelan fiscal printer, credit-note types). Purely informative: the server re-validates every write regardless.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "sales-invoices", ":id", "capabilities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Sales invoice ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "9393f08b-7d4b-461a-a04e-7e12a4fc9245", "name": "Editability matrix", "originalRequest": { "url": { "path": [ "api", "v2", "sales-invoices", ":id", "capabilities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales invoice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"header\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"counterparty\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"documentDate\": {\n \"allowed\": \"\",\n \"code\": \"VERIFACTU_STATE\",\n \"reason\": \"\"\n },\n \"internalFields\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"amounts\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"unitPrices\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"manualDiscounts\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"lineDescriptions\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"products\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"quantities\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"accounting\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"payments\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"insurerAmounts\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"costCenters\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"opticalOrders\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"edit\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"delete\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7d14e30d-3ad4-4461-adb7-0279bdb20478", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "sales-invoices", ":id", "capabilities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales invoice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ade4afc0-7f7d-4f3a-8aa9-507c88063368", "name": "Authenticated user is missing the `VER_FACTURASEMITIDAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "sales-invoices", ":id", "capabilities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales invoice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e35ff5e6-6242-4439-84f0-0ce7c52a94d5", "name": "Sales invoice not found", "originalRequest": { "url": { "path": [ "api", "v2", "sales-invoices", ":id", "capabilities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales invoice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3667ceba-b386-4dff-a671-81da420bcd9c", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-invoices", ":id", "capabilities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales invoice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "id": "351ad4b0-d9e8-43aa-b33a-3065f0616350", "name": "List sales invoices", "request": { "name": "List sales invoices", "description": { "content": "Returns a paginated list of customer sales invoices with envelope `{data, totalCount, skip, limit, hasMore}`. Supports optional RSQL `filter`, `sort` (default `lastModifiedAt:desc`), `skip`/`limit` pagination and `modifiedAfter`/`modifiedBefore` bookends. Limit is capped at 200; skip is clamped to >= 0. The constraint `issued==true` is always enforced server-side.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "sales-invoices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "be39d163-a82b-4486-8a9f-b6c3f4f000ba", "name": "Page of sales invoices", "originalRequest": { "url": { "path": [ "api", "v2", "sales-invoices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b4653505-8640-4949-9126-e1293213f034", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "sales-invoices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d3a50ff0-fa7d-4f02-8bbe-e49de264132f", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "sales-invoices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "adbb393d-326c-4f51-a0f7-b30daa18eda9", "name": "Authenticated user is missing the `VER_FACTURASEMITIDAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "sales-invoices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5929d266-1b96-4346-9cae-d875c88b0cc0", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-invoices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "41684281-7593-4ddc-ab87-99b2c2de6935", "name": "Create sales invoice", "request": { "name": "Create sales invoice", "description": { "content": "Creates a new customer sales invoice with the provided data and optional line items and payments. Business logic (accounting, stock, DTE) runs in the legacy WAR via the internal commands gateway. The `issued` flag is forced to `true` server-side regardless of the request payload.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "sales-invoices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"POINTS\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\",\n \"sunatUnitOfMeasure\": \"NIU\"\n }\n ],\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"pricesIncludeTax\": \"\",\n \"generateDeliveryNote\": \"\",\n \"issueDate\": \"\",\n \"accountingDate\": \"\",\n \"receptionDate\": \"\",\n \"counterpartyType\": \"MS\",\n \"accountingLedger\": \"\",\n \"linkedToAccounting\": \"\",\n \"counterpartyAccountId\": \"\",\n \"withholdingTaxAccountId\": \"\",\n \"activityId\": \"\",\n \"simplified\": \"\",\n \"saleCondition\": \"\",\n \"reverseCharge\": \"\",\n \"intraCommunity\": \"\",\n \"insuranceInvoice\": \"\",\n \"visitReasonId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryContractNumber\": \"\",\n \"secondaryContractNumber\": \"\",\n \"tertiaryContractNumber\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insuredPartyId\": \"\",\n \"insuredNationalId\": \"\",\n \"insuredPolicyNumber\": \"\",\n \"insuredClaimNumber\": \"\",\n \"pointsWalletToRedeemId\": \"\",\n \"pointsToRedeem\": \"\",\n \"discountPinId\": \"\",\n \"installments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n }\n ],\n \"electronicInvoice\": {\n \"signStatus\": \"RECEIVED_PENDING\",\n \"signedAt\": \"\",\n \"lastSignErrorCode\": \"\",\n \"lastSignErrorMessage\": \"\",\n \"sunatHash\": \"\",\n \"sunatInvoiceCode\": \"\",\n \"sunatQrCode\": \"\",\n \"dgiCufe\": \"\",\n \"dgiAuthorizationNumber\": \"\",\n \"dgiSecNumber\": \"\",\n \"dgiDv\": \"\",\n \"dgiQrCode\": \"\",\n \"dgiSystemRef\": \"\"\n },\n \"sunatPaymentMethod\": \"CR\",\n \"capabilities\": {\n \"header\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"counterparty\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"documentDate\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"internalFields\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"amounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"unitPrices\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"manualDiscounts\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"lineDescriptions\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"products\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"quantities\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"accounting\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"payments\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"insurerAmounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"costCenters\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"opticalOrders\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"edit\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"delete\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n }\n },\n \"einvoiceError\": \"\",\n \"einvoiceXmlUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "6b77303f-ee44-46bb-b0f3-a7d54b2afd3a", "name": "Sales invoice created", "originalRequest": { "url": { "path": [ "api", "v2", "sales-invoices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"POINTS\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\",\n \"sunatUnitOfMeasure\": \"NIU\"\n }\n ],\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"pricesIncludeTax\": \"\",\n \"generateDeliveryNote\": \"\",\n \"issueDate\": \"\",\n \"accountingDate\": \"\",\n \"receptionDate\": \"\",\n \"counterpartyType\": \"MS\",\n \"accountingLedger\": \"\",\n \"linkedToAccounting\": \"\",\n \"counterpartyAccountId\": \"\",\n \"withholdingTaxAccountId\": \"\",\n \"activityId\": \"\",\n \"simplified\": \"\",\n \"saleCondition\": \"\",\n \"reverseCharge\": \"\",\n \"intraCommunity\": \"\",\n \"insuranceInvoice\": \"\",\n \"visitReasonId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryContractNumber\": \"\",\n \"secondaryContractNumber\": \"\",\n \"tertiaryContractNumber\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insuredPartyId\": \"\",\n \"insuredNationalId\": \"\",\n \"insuredPolicyNumber\": \"\",\n \"insuredClaimNumber\": \"\",\n \"pointsWalletToRedeemId\": \"\",\n \"pointsToRedeem\": \"\",\n \"discountPinId\": \"\",\n \"installments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n }\n ],\n \"electronicInvoice\": {\n \"signStatus\": \"RECEIVED_PENDING\",\n \"signedAt\": \"\",\n \"lastSignErrorCode\": \"\",\n \"lastSignErrorMessage\": \"\",\n \"sunatHash\": \"\",\n \"sunatInvoiceCode\": \"\",\n \"sunatQrCode\": \"\",\n \"dgiCufe\": \"\",\n \"dgiAuthorizationNumber\": \"\",\n \"dgiSecNumber\": \"\",\n \"dgiDv\": \"\",\n \"dgiQrCode\": \"\",\n \"dgiSystemRef\": \"\"\n },\n \"sunatPaymentMethod\": \"CR\",\n \"capabilities\": {\n \"header\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"counterparty\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"documentDate\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"internalFields\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"amounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"unitPrices\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"manualDiscounts\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"lineDescriptions\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"products\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"quantities\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"accounting\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"payments\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"insurerAmounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"costCenters\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"opticalOrders\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"edit\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"delete\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n }\n },\n \"einvoiceError\": \"\",\n \"einvoiceXmlUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"counterpartyId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"grossAmount\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatPct\": \"\",\n \"vatAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"surchargePct\": \"\",\n \"surchargeAmount\": \"\",\n \"total\": \"\",\n \"commercialTotalAmount\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n }\n ],\n \"appliedPriceRule\": {\n \"id\": \"\",\n \"ruleType\": \"COMBO\",\n \"tariffId\": \"\",\n \"tariffName\": \"\",\n \"comboId\": \"\",\n \"comboName\": \"\",\n \"purchaseCondition\": \"\",\n \"purchaseConditionId\": \"\",\n \"discountConditionId\": \"\",\n \"discountValue\": \"\",\n \"categoryIds\": [\n \"\"\n ]\n },\n \"excludedTariffIds\": [\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"grossAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"reservedQuantity\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"PURCHASE_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"opticalOrderId\": \"\",\n \"deliveryStatus\": \"\",\n \"sunatUnitOfMeasure\": \"NIU\"\n }\n ],\n \"warehouseId\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"documentType\": \"INVOICE\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"deliveryStatus\": \"EP\",\n \"lifecycleStatus\": \"\",\n \"paymentStatus\": \"UNPAID\",\n \"documentStatusId\": \"\",\n \"documentStatusName\": \"\",\n \"issued\": \"\",\n \"draft\": \"\",\n \"enabled\": \"\",\n \"verified\": \"\",\n \"documentDate\": \"\",\n \"shippingDate\": \"\",\n \"counterpartyName\": \"\",\n \"counterpartyTaxId\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"companyTaxId\": \"\",\n \"warehouseName\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"optometristId\": \"\",\n \"optometristName\": \"\",\n \"documentTypeId\": \"\",\n \"documentTypeName\": \"\",\n \"paymentTermsId\": \"\",\n \"paymentTermsName\": \"\",\n \"basePriceListId\": \"\",\n \"basePriceListName\": \"\",\n \"discountPriceListId\": \"\",\n \"discountPriceListName\": \"\",\n \"taxBehavior\": \"EXEMPT\",\n \"withholdingTaxTypeId\": \"\",\n \"withholdingTaxTypeName\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"totalQuantity\": \"\",\n \"grossAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"discountAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"specialDiscountPct\": \"\",\n \"specialDiscountAmount\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"earlyPaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatAmount\": \"\",\n \"surchargeEquivalencePct\": \"\",\n \"surchargeEquivalenceAmount\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"withholdingTaxAmount\": \"\",\n \"shippingAmount\": \"\",\n \"financingPct\": \"\",\n \"financingAmount\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"commercialTotalAmount\": \"\",\n \"total\": \"\",\n \"totalPaid\": \"\",\n \"outstandingAmount\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"currencyDecimals\": \"\",\n \"currencyDecimalsSystem\": \"\",\n \"exchangeRate\": \"\",\n \"grossAmountSystem\": \"\",\n \"discountAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"roundingMode\": \"\",\n \"relationConcept\": \"\",\n \"relationType\": \"\",\n \"linkableQuantity\": \"\",\n \"relationQuantity\": \"\",\n \"totalApprovals\": \"\",\n \"validatedApprovals\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"QUOTE\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"RI\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"pricesIncludeTax\": \"\",\n \"generateDeliveryNote\": \"\",\n \"issueDate\": \"\",\n \"accountingDate\": \"\",\n \"receptionDate\": \"\",\n \"counterpartyType\": \"CC\",\n \"totalWithholdings\": \"\",\n \"accountingNumber\": \"\",\n \"journalEntryId\": \"\",\n \"accountingLedger\": \"\",\n \"linkedToAccounting\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"withholdingTaxAccountId\": \"\",\n \"withholdingTaxAccountName\": \"\",\n \"activityId\": \"\",\n \"activityName\": \"\",\n \"invoiceType\": \"SUB\",\n \"simplified\": \"\",\n \"creditNoteType\": \"\",\n \"saleCondition\": \"\",\n \"reverseCharge\": \"\",\n \"intraCommunity\": \"\",\n \"insuranceInvoice\": \"\",\n \"visitReasonId\": \"\",\n \"visitReasonName\": \"\",\n \"primaryInsurerId\": \"\",\n \"primaryInsurerName\": \"\",\n \"secondaryInsurerId\": \"\",\n \"secondaryInsurerName\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"tertiaryInsurerName\": \"\",\n \"primaryContractNumber\": \"\",\n \"secondaryContractNumber\": \"\",\n \"tertiaryContractNumber\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insuredPartyId\": \"\",\n \"insuredPartyName\": \"\",\n \"insuredNationalId\": \"\",\n \"insuredPolicyNumber\": \"\",\n \"insuredClaimNumber\": \"\",\n \"pointsWalletId\": \"\",\n \"pointsWalletToRedeemId\": \"\",\n \"customerPointsBalance\": \"\",\n \"pointsEarned\": \"\",\n \"pointsRedeemed\": \"\",\n \"pointsValueAmount\": \"\",\n \"opticalDataId\": \"\",\n \"discountPinId\": \"\",\n \"claimId\": \"\",\n \"installments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"dueDate\": \"\",\n \"paid\": \"\",\n \"issued\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"paymentId\": \"\",\n \"withholdingLineId\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"withholdingTaxPct\": \"\"\n }\n ],\n \"totalInstallments\": \"\",\n \"paidInstallments\": \"\",\n \"electronicInvoice\": {\n \"id\": \"\",\n \"signStatus\": \"SUBMIT_ERROR\",\n \"signedAt\": \"\",\n \"lastSignErrorCode\": \"\",\n \"lastSignErrorMessage\": \"\",\n \"sunatHash\": \"\",\n \"sunatInvoiceCode\": \"\",\n \"sunatQrCode\": \"\",\n \"dgiCufe\": \"\",\n \"dgiAuthorizationNumber\": \"\",\n \"dgiSecNumber\": \"\",\n \"dgiDv\": \"\",\n \"dgiQrCode\": \"\",\n \"dgiSystemRef\": \"\"\n },\n \"verifactuStatus\": \"\",\n \"verifactuReady\": \"\",\n \"cfdiUsage\": \"\",\n \"satPaymentMethod\": \"\",\n \"cancellationRecordId\": \"\",\n \"folioNumber\": \"\",\n \"establishmentCode\": \"\",\n \"emissionPointCode\": \"\",\n \"authorizationCode\": \"\",\n \"global\": \"\",\n \"globalInvoiceId\": \"\",\n \"fiscalDocumentNumber\": \"\",\n \"fiscalPrinterSerial\": \"\",\n \"sunatPaymentMethod\": \"CO\",\n \"capabilities\": {\n \"header\": {\n \"allowed\": \"\",\n \"code\": \"VERIFACTU_STATE\",\n \"reason\": \"\"\n },\n \"counterparty\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"documentDate\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"internalFields\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"amounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"unitPrices\": {\n \"allowed\": \"\",\n \"code\": \"VERIFACTU_STATE\",\n \"reason\": \"\"\n },\n \"manualDiscounts\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"lineDescriptions\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"products\": {\n \"allowed\": \"\",\n \"code\": \"VERIFACTU_STATE\",\n \"reason\": \"\"\n },\n \"quantities\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"accounting\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"payments\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"insurerAmounts\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"costCenters\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"opticalOrders\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"edit\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"delete\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n }\n },\n \"einvoiceError\": \"\",\n \"einvoiceXmlUrl\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f39a9c13-e230-40df-a77d-6545e9c2a7b1", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-invoices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"POINTS\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\",\n \"sunatUnitOfMeasure\": \"NIU\"\n }\n ],\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"pricesIncludeTax\": \"\",\n \"generateDeliveryNote\": \"\",\n \"issueDate\": \"\",\n \"accountingDate\": \"\",\n \"receptionDate\": \"\",\n \"counterpartyType\": \"MS\",\n \"accountingLedger\": \"\",\n \"linkedToAccounting\": \"\",\n \"counterpartyAccountId\": \"\",\n \"withholdingTaxAccountId\": \"\",\n \"activityId\": \"\",\n \"simplified\": \"\",\n \"saleCondition\": \"\",\n \"reverseCharge\": \"\",\n \"intraCommunity\": \"\",\n \"insuranceInvoice\": \"\",\n \"visitReasonId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryContractNumber\": \"\",\n \"secondaryContractNumber\": \"\",\n \"tertiaryContractNumber\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insuredPartyId\": \"\",\n \"insuredNationalId\": \"\",\n \"insuredPolicyNumber\": \"\",\n \"insuredClaimNumber\": \"\",\n \"pointsWalletToRedeemId\": \"\",\n \"pointsToRedeem\": \"\",\n \"discountPinId\": \"\",\n \"installments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n }\n ],\n \"electronicInvoice\": {\n \"signStatus\": \"RECEIVED_PENDING\",\n \"signedAt\": \"\",\n \"lastSignErrorCode\": \"\",\n \"lastSignErrorMessage\": \"\",\n \"sunatHash\": \"\",\n \"sunatInvoiceCode\": \"\",\n \"sunatQrCode\": \"\",\n \"dgiCufe\": \"\",\n \"dgiAuthorizationNumber\": \"\",\n \"dgiSecNumber\": \"\",\n \"dgiDv\": \"\",\n \"dgiQrCode\": \"\",\n \"dgiSystemRef\": \"\"\n },\n \"sunatPaymentMethod\": \"CR\",\n \"capabilities\": {\n \"header\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"counterparty\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"documentDate\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"internalFields\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"amounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"unitPrices\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"manualDiscounts\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"lineDescriptions\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"products\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"quantities\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"accounting\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"payments\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"insurerAmounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"costCenters\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"opticalOrders\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"edit\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"delete\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n }\n },\n \"einvoiceError\": \"\",\n \"einvoiceXmlUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "034656f8-d824-4368-8d45-8a3be2b8cd9a", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "sales-invoices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"POINTS\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\",\n \"sunatUnitOfMeasure\": \"NIU\"\n }\n ],\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"pricesIncludeTax\": \"\",\n \"generateDeliveryNote\": \"\",\n \"issueDate\": \"\",\n \"accountingDate\": \"\",\n \"receptionDate\": \"\",\n \"counterpartyType\": \"MS\",\n \"accountingLedger\": \"\",\n \"linkedToAccounting\": \"\",\n \"counterpartyAccountId\": \"\",\n \"withholdingTaxAccountId\": \"\",\n \"activityId\": \"\",\n \"simplified\": \"\",\n \"saleCondition\": \"\",\n \"reverseCharge\": \"\",\n \"intraCommunity\": \"\",\n \"insuranceInvoice\": \"\",\n \"visitReasonId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryContractNumber\": \"\",\n \"secondaryContractNumber\": \"\",\n \"tertiaryContractNumber\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insuredPartyId\": \"\",\n \"insuredNationalId\": \"\",\n \"insuredPolicyNumber\": \"\",\n \"insuredClaimNumber\": \"\",\n \"pointsWalletToRedeemId\": \"\",\n \"pointsToRedeem\": \"\",\n \"discountPinId\": \"\",\n \"installments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n }\n ],\n \"electronicInvoice\": {\n \"signStatus\": \"RECEIVED_PENDING\",\n \"signedAt\": \"\",\n \"lastSignErrorCode\": \"\",\n \"lastSignErrorMessage\": \"\",\n \"sunatHash\": \"\",\n \"sunatInvoiceCode\": \"\",\n \"sunatQrCode\": \"\",\n \"dgiCufe\": \"\",\n \"dgiAuthorizationNumber\": \"\",\n \"dgiSecNumber\": \"\",\n \"dgiDv\": \"\",\n \"dgiQrCode\": \"\",\n \"dgiSystemRef\": \"\"\n },\n \"sunatPaymentMethod\": \"CR\",\n \"capabilities\": {\n \"header\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"counterparty\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"documentDate\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"internalFields\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"amounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"unitPrices\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"manualDiscounts\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"lineDescriptions\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"products\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"quantities\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"accounting\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"payments\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"insurerAmounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"costCenters\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"opticalOrders\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"edit\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"delete\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n }\n },\n \"einvoiceError\": \"\",\n \"einvoiceXmlUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0f854dd8-85a3-4b4d-9f08-447f736f400c", "name": "Authenticated user is missing the `CREAR_FACTURASEMITIDAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "sales-invoices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"POINTS\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\",\n \"sunatUnitOfMeasure\": \"NIU\"\n }\n ],\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"pricesIncludeTax\": \"\",\n \"generateDeliveryNote\": \"\",\n \"issueDate\": \"\",\n \"accountingDate\": \"\",\n \"receptionDate\": \"\",\n \"counterpartyType\": \"MS\",\n \"accountingLedger\": \"\",\n \"linkedToAccounting\": \"\",\n \"counterpartyAccountId\": \"\",\n \"withholdingTaxAccountId\": \"\",\n \"activityId\": \"\",\n \"simplified\": \"\",\n \"saleCondition\": \"\",\n \"reverseCharge\": \"\",\n \"intraCommunity\": \"\",\n \"insuranceInvoice\": \"\",\n \"visitReasonId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryContractNumber\": \"\",\n \"secondaryContractNumber\": \"\",\n \"tertiaryContractNumber\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insuredPartyId\": \"\",\n \"insuredNationalId\": \"\",\n \"insuredPolicyNumber\": \"\",\n \"insuredClaimNumber\": \"\",\n \"pointsWalletToRedeemId\": \"\",\n \"pointsToRedeem\": \"\",\n \"discountPinId\": \"\",\n \"installments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n }\n ],\n \"electronicInvoice\": {\n \"signStatus\": \"RECEIVED_PENDING\",\n \"signedAt\": \"\",\n \"lastSignErrorCode\": \"\",\n \"lastSignErrorMessage\": \"\",\n \"sunatHash\": \"\",\n \"sunatInvoiceCode\": \"\",\n \"sunatQrCode\": \"\",\n \"dgiCufe\": \"\",\n \"dgiAuthorizationNumber\": \"\",\n \"dgiSecNumber\": \"\",\n \"dgiDv\": \"\",\n \"dgiQrCode\": \"\",\n \"dgiSystemRef\": \"\"\n },\n \"sunatPaymentMethod\": \"CR\",\n \"capabilities\": {\n \"header\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"counterparty\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"documentDate\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"internalFields\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"amounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"unitPrices\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"manualDiscounts\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"lineDescriptions\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"products\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"quantities\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"accounting\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"payments\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"insurerAmounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"costCenters\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"opticalOrders\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"edit\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"delete\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n }\n },\n \"einvoiceError\": \"\",\n \"einvoiceXmlUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "baeea6a0-ac27-483c-b789-0e1e9236c2a3", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-invoices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"POINTS\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\",\n \"sunatUnitOfMeasure\": \"NIU\"\n }\n ],\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"pricesIncludeTax\": \"\",\n \"generateDeliveryNote\": \"\",\n \"issueDate\": \"\",\n \"accountingDate\": \"\",\n \"receptionDate\": \"\",\n \"counterpartyType\": \"MS\",\n \"accountingLedger\": \"\",\n \"linkedToAccounting\": \"\",\n \"counterpartyAccountId\": \"\",\n \"withholdingTaxAccountId\": \"\",\n \"activityId\": \"\",\n \"simplified\": \"\",\n \"saleCondition\": \"\",\n \"reverseCharge\": \"\",\n \"intraCommunity\": \"\",\n \"insuranceInvoice\": \"\",\n \"visitReasonId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryContractNumber\": \"\",\n \"secondaryContractNumber\": \"\",\n \"tertiaryContractNumber\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insuredPartyId\": \"\",\n \"insuredNationalId\": \"\",\n \"insuredPolicyNumber\": \"\",\n \"insuredClaimNumber\": \"\",\n \"pointsWalletToRedeemId\": \"\",\n \"pointsToRedeem\": \"\",\n \"discountPinId\": \"\",\n \"installments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n }\n ],\n \"electronicInvoice\": {\n \"signStatus\": \"RECEIVED_PENDING\",\n \"signedAt\": \"\",\n \"lastSignErrorCode\": \"\",\n \"lastSignErrorMessage\": \"\",\n \"sunatHash\": \"\",\n \"sunatInvoiceCode\": \"\",\n \"sunatQrCode\": \"\",\n \"dgiCufe\": \"\",\n \"dgiAuthorizationNumber\": \"\",\n \"dgiSecNumber\": \"\",\n \"dgiDv\": \"\",\n \"dgiQrCode\": \"\",\n \"dgiSystemRef\": \"\"\n },\n \"sunatPaymentMethod\": \"CR\",\n \"capabilities\": {\n \"header\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"counterparty\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"documentDate\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"internalFields\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"amounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"unitPrices\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"manualDiscounts\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"lineDescriptions\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"products\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"quantities\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"accounting\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"payments\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"insurerAmounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"costCenters\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"opticalOrders\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"edit\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"delete\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n }\n },\n \"einvoiceError\": \"\",\n \"einvoiceXmlUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "new", "description": "", "item": [ { "id": "0aaf2b99-ec17-4895-90a9-ed0a0b1c6c91", "name": "Prototype sales invoice for a creation form", "request": { "name": "Prototype sales invoice for a creation form", "description": { "content": "Returns a NON-PERSISTED sales invoice pre-populated with the backend defaults the legacy form applies on 'new invoice': currencies and daily exchange rate of the branch's company, default accounting ledger, automatic document/accounting dates per company configuration, loyalty point value, Verifactu draft state (lifecycle BOR + series BORRADOR) when the company has Verifactu active, a PROVISIONAL series/number pair (re-derived at persist time) and the authenticated user's employee as agent or optometrist. The response carries no `id`, `version` or audit fields. The optional JSON body supplies initialisation hints: `warehouseId` (defaults to the user's current branch) and `counterpartyId`. Caller must follow up with `POST /api/v2/sales-invoices` to actually persist the invoice.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "sales-invoices", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "66ead251-0cd0-459c-ab15-41581d28a79c", "name": "Sales invoice prototype with defaults", "originalRequest": { "url": { "path": [ "api", "v2", "sales-invoices", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"counterpartyId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"grossAmount\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatPct\": \"\",\n \"vatAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"surchargePct\": \"\",\n \"surchargeAmount\": \"\",\n \"total\": \"\",\n \"commercialTotalAmount\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n }\n ],\n \"appliedPriceRule\": {\n \"id\": \"\",\n \"ruleType\": \"COMBO\",\n \"tariffId\": \"\",\n \"tariffName\": \"\",\n \"comboId\": \"\",\n \"comboName\": \"\",\n \"purchaseCondition\": \"\",\n \"purchaseConditionId\": \"\",\n \"discountConditionId\": \"\",\n \"discountValue\": \"\",\n \"categoryIds\": [\n \"\"\n ]\n },\n \"excludedTariffIds\": [\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"grossAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"reservedQuantity\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"PURCHASE_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"opticalOrderId\": \"\",\n \"deliveryStatus\": \"\",\n \"sunatUnitOfMeasure\": \"NIU\"\n }\n ],\n \"warehouseId\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"documentType\": \"INVOICE\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"deliveryStatus\": \"EP\",\n \"lifecycleStatus\": \"\",\n \"paymentStatus\": \"UNPAID\",\n \"documentStatusId\": \"\",\n \"documentStatusName\": \"\",\n \"issued\": \"\",\n \"draft\": \"\",\n \"enabled\": \"\",\n \"verified\": \"\",\n \"documentDate\": \"\",\n \"shippingDate\": \"\",\n \"counterpartyName\": \"\",\n \"counterpartyTaxId\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"companyTaxId\": \"\",\n \"warehouseName\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"optometristId\": \"\",\n \"optometristName\": \"\",\n \"documentTypeId\": \"\",\n \"documentTypeName\": \"\",\n \"paymentTermsId\": \"\",\n \"paymentTermsName\": \"\",\n \"basePriceListId\": \"\",\n \"basePriceListName\": \"\",\n \"discountPriceListId\": \"\",\n \"discountPriceListName\": \"\",\n \"taxBehavior\": \"EXEMPT\",\n \"withholdingTaxTypeId\": \"\",\n \"withholdingTaxTypeName\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"totalQuantity\": \"\",\n \"grossAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"discountAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"specialDiscountPct\": \"\",\n \"specialDiscountAmount\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"earlyPaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatAmount\": \"\",\n \"surchargeEquivalencePct\": \"\",\n \"surchargeEquivalenceAmount\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"withholdingTaxAmount\": \"\",\n \"shippingAmount\": \"\",\n \"financingPct\": \"\",\n \"financingAmount\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"commercialTotalAmount\": \"\",\n \"total\": \"\",\n \"totalPaid\": \"\",\n \"outstandingAmount\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"currencyDecimals\": \"\",\n \"currencyDecimalsSystem\": \"\",\n \"exchangeRate\": \"\",\n \"grossAmountSystem\": \"\",\n \"discountAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"roundingMode\": \"\",\n \"relationConcept\": \"\",\n \"relationType\": \"\",\n \"linkableQuantity\": \"\",\n \"relationQuantity\": \"\",\n \"totalApprovals\": \"\",\n \"validatedApprovals\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"QUOTE\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"RI\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"pricesIncludeTax\": \"\",\n \"generateDeliveryNote\": \"\",\n \"issueDate\": \"\",\n \"accountingDate\": \"\",\n \"receptionDate\": \"\",\n \"counterpartyType\": \"CC\",\n \"totalWithholdings\": \"\",\n \"accountingNumber\": \"\",\n \"journalEntryId\": \"\",\n \"accountingLedger\": \"\",\n \"linkedToAccounting\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"withholdingTaxAccountId\": \"\",\n \"withholdingTaxAccountName\": \"\",\n \"activityId\": \"\",\n \"activityName\": \"\",\n \"invoiceType\": \"SUB\",\n \"simplified\": \"\",\n \"creditNoteType\": \"\",\n \"saleCondition\": \"\",\n \"reverseCharge\": \"\",\n \"intraCommunity\": \"\",\n \"insuranceInvoice\": \"\",\n \"visitReasonId\": \"\",\n \"visitReasonName\": \"\",\n \"primaryInsurerId\": \"\",\n \"primaryInsurerName\": \"\",\n \"secondaryInsurerId\": \"\",\n \"secondaryInsurerName\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"tertiaryInsurerName\": \"\",\n \"primaryContractNumber\": \"\",\n \"secondaryContractNumber\": \"\",\n \"tertiaryContractNumber\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insuredPartyId\": \"\",\n \"insuredPartyName\": \"\",\n \"insuredNationalId\": \"\",\n \"insuredPolicyNumber\": \"\",\n \"insuredClaimNumber\": \"\",\n \"pointsWalletId\": \"\",\n \"pointsWalletToRedeemId\": \"\",\n \"customerPointsBalance\": \"\",\n \"pointsEarned\": \"\",\n \"pointsRedeemed\": \"\",\n \"pointsValueAmount\": \"\",\n \"opticalDataId\": \"\",\n \"discountPinId\": \"\",\n \"claimId\": \"\",\n \"installments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"dueDate\": \"\",\n \"paid\": \"\",\n \"issued\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"paymentId\": \"\",\n \"withholdingLineId\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"withholdingTaxPct\": \"\"\n }\n ],\n \"totalInstallments\": \"\",\n \"paidInstallments\": \"\",\n \"electronicInvoice\": {\n \"id\": \"\",\n \"signStatus\": \"SUBMIT_ERROR\",\n \"signedAt\": \"\",\n \"lastSignErrorCode\": \"\",\n \"lastSignErrorMessage\": \"\",\n \"sunatHash\": \"\",\n \"sunatInvoiceCode\": \"\",\n \"sunatQrCode\": \"\",\n \"dgiCufe\": \"\",\n \"dgiAuthorizationNumber\": \"\",\n \"dgiSecNumber\": \"\",\n \"dgiDv\": \"\",\n \"dgiQrCode\": \"\",\n \"dgiSystemRef\": \"\"\n },\n \"verifactuStatus\": \"\",\n \"verifactuReady\": \"\",\n \"cfdiUsage\": \"\",\n \"satPaymentMethod\": \"\",\n \"cancellationRecordId\": \"\",\n \"folioNumber\": \"\",\n \"establishmentCode\": \"\",\n \"emissionPointCode\": \"\",\n \"authorizationCode\": \"\",\n \"global\": \"\",\n \"globalInvoiceId\": \"\",\n \"fiscalDocumentNumber\": \"\",\n \"fiscalPrinterSerial\": \"\",\n \"sunatPaymentMethod\": \"CO\",\n \"capabilities\": {\n \"header\": {\n \"allowed\": \"\",\n \"code\": \"VERIFACTU_STATE\",\n \"reason\": \"\"\n },\n \"counterparty\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"documentDate\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"internalFields\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"amounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"unitPrices\": {\n \"allowed\": \"\",\n \"code\": \"VERIFACTU_STATE\",\n \"reason\": \"\"\n },\n \"manualDiscounts\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"lineDescriptions\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"products\": {\n \"allowed\": \"\",\n \"code\": \"VERIFACTU_STATE\",\n \"reason\": \"\"\n },\n \"quantities\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"accounting\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"payments\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"insurerAmounts\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"costCenters\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"opticalOrders\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"edit\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"delete\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n }\n },\n \"einvoiceError\": \"\",\n \"einvoiceXmlUrl\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "eea38cbe-e66c-4a89-aafe-8114c73a821f", "name": "Hint references an unknown entity (warehouse, counterparty) or the user has no default branch", "originalRequest": { "url": { "path": [ "api", "v2", "sales-invoices", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1b7c43d2-3425-469e-8dac-340ec2d9f27c", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "sales-invoices", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "55f4c0e0-0cef-49e6-9daf-416d527f6dfd", "name": "Authenticated user is missing the `CREAR_FACTURASEMITIDAS` permission or the requested warehouse is outside the user's scope", "originalRequest": { "url": { "path": [ "api", "v2", "sales-invoices", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f3986b7c-31e6-4cf7-abbf-7243d54e30da", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-invoices", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "sales-delivery-notes", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "05787a24-983d-4fe4-bbbf-23767c948b90", "name": "Get sales delivery note by ID", "request": { "name": "Get sales delivery note by ID", "description": { "content": "Returns a single customer sales delivery note by its primary key, including line items and payments. Listing (`GET` without id) returns headers only. The response carries a strong `ETag` header with the current version.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "sales-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Sales delivery note ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "ab907187-0ecd-4c6b-9aac-7f0e719c38e7", "name": "Sales delivery note found", "originalRequest": { "url": { "path": [ "api", "v2", "sales-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales delivery note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"documentType\": \"INVOICE\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"deliveryStatus\": \"EP\",\n \"lifecycleStatus\": \"\",\n \"paymentStatus\": \"OVERPAID\",\n \"documentStatusId\": \"\",\n \"documentStatusName\": \"\",\n \"issued\": \"\",\n \"draft\": \"\",\n \"enabled\": \"\",\n \"verified\": \"\",\n \"documentDate\": \"\",\n \"shippingDate\": \"\",\n \"counterpartyName\": \"\",\n \"counterpartyTaxId\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"companyTaxId\": \"\",\n \"warehouseName\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"optometristId\": \"\",\n \"optometristName\": \"\",\n \"documentTypeId\": \"\",\n \"documentTypeName\": \"\",\n \"paymentTermsId\": \"\",\n \"paymentTermsName\": \"\",\n \"basePriceListId\": \"\",\n \"basePriceListName\": \"\",\n \"discountPriceListId\": \"\",\n \"discountPriceListName\": \"\",\n \"taxBehavior\": \"INCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"withholdingTaxTypeName\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"totalQuantity\": \"\",\n \"grossAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"discountAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"specialDiscountPct\": \"\",\n \"specialDiscountAmount\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"earlyPaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatAmount\": \"\",\n \"surchargeEquivalencePct\": \"\",\n \"surchargeEquivalenceAmount\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"withholdingTaxAmount\": \"\",\n \"shippingAmount\": \"\",\n \"financingPct\": \"\",\n \"financingAmount\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"commercialTotalAmount\": \"\",\n \"total\": \"\",\n \"totalPaid\": \"\",\n \"outstandingAmount\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"currencyDecimals\": \"\",\n \"currencyDecimalsSystem\": \"\",\n \"exchangeRate\": \"\",\n \"grossAmountSystem\": \"\",\n \"discountAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"roundingMode\": \"\",\n \"relationConcept\": \"\",\n \"relationType\": \"\",\n \"linkableQuantity\": \"\",\n \"relationQuantity\": \"\",\n \"totalApprovals\": \"\",\n \"validatedApprovals\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"REPAIR_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"CLAIM\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"RI\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"CP\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"grossAmount\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatPct\": \"\",\n \"vatAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"surchargePct\": \"\",\n \"surchargeAmount\": \"\",\n \"total\": \"\",\n \"commercialTotalAmount\": \"\",\n \"discounts\": [\n {\n \"type\": \"INSURER\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"id\": \"\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n }\n ],\n \"appliedPriceRule\": {\n \"id\": \"\",\n \"ruleType\": \"DISCOUNT\",\n \"tariffId\": \"\",\n \"tariffName\": \"\",\n \"comboId\": \"\",\n \"comboName\": \"\",\n \"purchaseCondition\": \"\",\n \"purchaseConditionId\": \"\",\n \"discountConditionId\": \"\",\n \"discountValue\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ]\n },\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"grossAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"reservedQuantity\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"QUOTE\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"MANUFACTURING_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"opticalOrderId\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"grossAmount\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatPct\": \"\",\n \"vatAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"surchargePct\": \"\",\n \"surchargeAmount\": \"\",\n \"total\": \"\",\n \"commercialTotalAmount\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n },\n {\n \"type\": \"PIN\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n }\n ],\n \"appliedPriceRule\": {\n \"id\": \"\",\n \"ruleType\": \"PIN\",\n \"tariffId\": \"\",\n \"tariffName\": \"\",\n \"comboId\": \"\",\n \"comboName\": \"\",\n \"purchaseCondition\": \"\",\n \"purchaseConditionId\": \"\",\n \"discountConditionId\": \"\",\n \"discountValue\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ]\n },\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"grossAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"reservedQuantity\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"CLAIM\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"REPAIR_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"opticalOrderId\": \"\"\n }\n ],\n \"carrierId\": \"\",\n \"carrierName\": \"\",\n \"carrierTaxId\": \"\",\n \"driverName\": \"\",\n \"vehicleId\": \"\",\n \"vehiclePlate\": \"\",\n \"vehicleModel\": \"\",\n \"shipmentNumber\": \"\",\n \"transportNote\": \"\",\n \"loadingNote\": \"\",\n \"quickReceive\": \"\",\n \"tareWeight\": \"\",\n \"grossWeight\": \"\",\n \"netWeight\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2b1d7397-ff40-48ef-beb8-4f89d11a7cab", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "sales-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales delivery note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c5e09155-8475-43f1-89d2-f940a1397c5a", "name": "Authenticated user is missing the `VER_ALBARANESENTREGA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "sales-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales delivery note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "da1c9c3e-868b-4bf1-ba42-1b5eef1efd9d", "name": "Sales delivery note not found", "originalRequest": { "url": { "path": [ "api", "v2", "sales-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales delivery note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8386c007-b886-410b-9032-94df2579a7e3", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales delivery note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4b1a32b5-9bdd-467d-b142-2f1534303f06", "name": "Update sales delivery note", "request": { "name": "Update sales delivery note", "description": { "content": "Full replacement of an existing customer sales delivery note. Send the `If-Match` header with the current ETag for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "sales-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Sales delivery note ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"INCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"INVOICE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"carrierId\": \"\",\n \"driverName\": \"\",\n \"vehicleId\": \"\",\n \"vehiclePlate\": \"\",\n \"shipmentNumber\": \"\",\n \"transportNote\": \"\",\n \"loadingNote\": \"\",\n \"tareWeight\": \"\",\n \"grossWeight\": \"\",\n \"netWeight\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "079b8e25-78be-4711-863f-278b80c571f5", "name": "Sales delivery note updated", "originalRequest": { "url": { "path": [ "api", "v2", "sales-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales delivery note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"INCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"INVOICE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"carrierId\": \"\",\n \"driverName\": \"\",\n \"vehicleId\": \"\",\n \"vehiclePlate\": \"\",\n \"shipmentNumber\": \"\",\n \"transportNote\": \"\",\n \"loadingNote\": \"\",\n \"tareWeight\": \"\",\n \"grossWeight\": \"\",\n \"netWeight\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"documentType\": \"INVOICE\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"deliveryStatus\": \"EP\",\n \"lifecycleStatus\": \"\",\n \"paymentStatus\": \"OVERPAID\",\n \"documentStatusId\": \"\",\n \"documentStatusName\": \"\",\n \"issued\": \"\",\n \"draft\": \"\",\n \"enabled\": \"\",\n \"verified\": \"\",\n \"documentDate\": \"\",\n \"shippingDate\": \"\",\n \"counterpartyName\": \"\",\n \"counterpartyTaxId\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"companyTaxId\": \"\",\n \"warehouseName\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"optometristId\": \"\",\n \"optometristName\": \"\",\n \"documentTypeId\": \"\",\n \"documentTypeName\": \"\",\n \"paymentTermsId\": \"\",\n \"paymentTermsName\": \"\",\n \"basePriceListId\": \"\",\n \"basePriceListName\": \"\",\n \"discountPriceListId\": \"\",\n \"discountPriceListName\": \"\",\n \"taxBehavior\": \"INCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"withholdingTaxTypeName\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"totalQuantity\": \"\",\n \"grossAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"discountAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"specialDiscountPct\": \"\",\n \"specialDiscountAmount\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"earlyPaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatAmount\": \"\",\n \"surchargeEquivalencePct\": \"\",\n \"surchargeEquivalenceAmount\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"withholdingTaxAmount\": \"\",\n \"shippingAmount\": \"\",\n \"financingPct\": \"\",\n \"financingAmount\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"commercialTotalAmount\": \"\",\n \"total\": \"\",\n \"totalPaid\": \"\",\n \"outstandingAmount\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"currencyDecimals\": \"\",\n \"currencyDecimalsSystem\": \"\",\n \"exchangeRate\": \"\",\n \"grossAmountSystem\": \"\",\n \"discountAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"roundingMode\": \"\",\n \"relationConcept\": \"\",\n \"relationType\": \"\",\n \"linkableQuantity\": \"\",\n \"relationQuantity\": \"\",\n \"totalApprovals\": \"\",\n \"validatedApprovals\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"REPAIR_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"CLAIM\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"RI\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"CP\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"grossAmount\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatPct\": \"\",\n \"vatAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"surchargePct\": \"\",\n \"surchargeAmount\": \"\",\n \"total\": \"\",\n \"commercialTotalAmount\": \"\",\n \"discounts\": [\n {\n \"type\": \"INSURER\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"id\": \"\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n }\n ],\n \"appliedPriceRule\": {\n \"id\": \"\",\n \"ruleType\": \"DISCOUNT\",\n \"tariffId\": \"\",\n \"tariffName\": \"\",\n \"comboId\": \"\",\n \"comboName\": \"\",\n \"purchaseCondition\": \"\",\n \"purchaseConditionId\": \"\",\n \"discountConditionId\": \"\",\n \"discountValue\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ]\n },\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"grossAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"reservedQuantity\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"QUOTE\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"MANUFACTURING_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"opticalOrderId\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"grossAmount\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatPct\": \"\",\n \"vatAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"surchargePct\": \"\",\n \"surchargeAmount\": \"\",\n \"total\": \"\",\n \"commercialTotalAmount\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n },\n {\n \"type\": \"PIN\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n }\n ],\n \"appliedPriceRule\": {\n \"id\": \"\",\n \"ruleType\": \"PIN\",\n \"tariffId\": \"\",\n \"tariffName\": \"\",\n \"comboId\": \"\",\n \"comboName\": \"\",\n \"purchaseCondition\": \"\",\n \"purchaseConditionId\": \"\",\n \"discountConditionId\": \"\",\n \"discountValue\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ]\n },\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"grossAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"reservedQuantity\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"CLAIM\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"REPAIR_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"opticalOrderId\": \"\"\n }\n ],\n \"carrierId\": \"\",\n \"carrierName\": \"\",\n \"carrierTaxId\": \"\",\n \"driverName\": \"\",\n \"vehicleId\": \"\",\n \"vehiclePlate\": \"\",\n \"vehicleModel\": \"\",\n \"shipmentNumber\": \"\",\n \"transportNote\": \"\",\n \"loadingNote\": \"\",\n \"quickReceive\": \"\",\n \"tareWeight\": \"\",\n \"grossWeight\": \"\",\n \"netWeight\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a19b103a-3e0e-4301-94f7-8e23a3035d0f", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales delivery note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"INCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"INVOICE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"carrierId\": \"\",\n \"driverName\": \"\",\n \"vehicleId\": \"\",\n \"vehiclePlate\": \"\",\n \"shipmentNumber\": \"\",\n \"transportNote\": \"\",\n \"loadingNote\": \"\",\n \"tareWeight\": \"\",\n \"grossWeight\": \"\",\n \"netWeight\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5beae3de-23fc-48b7-986e-e18530e22033", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "sales-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales delivery note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"INCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"INVOICE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"carrierId\": \"\",\n \"driverName\": \"\",\n \"vehicleId\": \"\",\n \"vehiclePlate\": \"\",\n \"shipmentNumber\": \"\",\n \"transportNote\": \"\",\n \"loadingNote\": \"\",\n \"tareWeight\": \"\",\n \"grossWeight\": \"\",\n \"netWeight\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3c8ceb69-62ea-49e8-9d78-def448356e97", "name": "Authenticated user is missing the `EDITAR_ALBARANESENTREGA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "sales-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales delivery note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"INCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"INVOICE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"carrierId\": \"\",\n \"driverName\": \"\",\n \"vehicleId\": \"\",\n \"vehiclePlate\": \"\",\n \"shipmentNumber\": \"\",\n \"transportNote\": \"\",\n \"loadingNote\": \"\",\n \"tareWeight\": \"\",\n \"grossWeight\": \"\",\n \"netWeight\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bb1f2513-efe1-4208-a732-6df861b620c5", "name": "Sales delivery note not found", "originalRequest": { "url": { "path": [ "api", "v2", "sales-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales delivery note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"INCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"INVOICE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"carrierId\": \"\",\n \"driverName\": \"\",\n \"vehicleId\": \"\",\n \"vehiclePlate\": \"\",\n \"shipmentNumber\": \"\",\n \"transportNote\": \"\",\n \"loadingNote\": \"\",\n \"tareWeight\": \"\",\n \"grossWeight\": \"\",\n \"netWeight\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "985dea16-2ee2-4a43-946e-777fb22efe30", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales delivery note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"INCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"INVOICE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"carrierId\": \"\",\n \"driverName\": \"\",\n \"vehicleId\": \"\",\n \"vehiclePlate\": \"\",\n \"shipmentNumber\": \"\",\n \"transportNote\": \"\",\n \"loadingNote\": \"\",\n \"tareWeight\": \"\",\n \"grossWeight\": \"\",\n \"netWeight\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d8d99491-31b7-45e6-91d0-b71c9efbaebd", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales delivery note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"INCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"INVOICE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"carrierId\": \"\",\n \"driverName\": \"\",\n \"vehicleId\": \"\",\n \"vehiclePlate\": \"\",\n \"shipmentNumber\": \"\",\n \"transportNote\": \"\",\n \"loadingNote\": \"\",\n \"tareWeight\": \"\",\n \"grossWeight\": \"\",\n \"netWeight\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4e9cd302-e07a-4f0f-87ae-6ccc0ebba9f8", "name": "Delete sales delivery note", "request": { "name": "Delete sales delivery note", "description": { "content": "Deletes a customer sales delivery note. Send the `If-Match` header with the current ETag for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "sales-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Sales delivery note ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "08257262-e66c-4c4f-a76a-920218c8532e", "name": "Sales delivery note deleted", "originalRequest": { "url": { "path": [ "api", "v2", "sales-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales delivery note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d7230871-926c-4915-8baa-439dc562419c", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "sales-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales delivery note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "643712d3-7fbb-4b18-9d0c-dd8f30259c43", "name": "Authenticated user is missing the `BORRAR_ALBARANESENTREGA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "sales-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales delivery note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ebb4f27c-1838-42f0-b05f-c7eaefc162e9", "name": "Sales delivery note not found", "originalRequest": { "url": { "path": [ "api", "v2", "sales-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales delivery note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "00103fd5-1e46-4582-af17-107a7313c330", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales delivery note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "55571122-8679-4ead-8b2d-2c65d25c96a2", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales delivery note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c751ef94-e14b-453b-93dc-c54024cbb855", "name": "Merge-patch sales delivery note", "request": { "name": "Merge-patch sales delivery note", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "sales-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Sales delivery note ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "28f64f0e-faad-4a81-8c0f-9f764d093418", "name": "Sales delivery note patched", "originalRequest": { "url": { "path": [ "api", "v2", "sales-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales delivery note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"documentType\": \"INVOICE\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"deliveryStatus\": \"EP\",\n \"lifecycleStatus\": \"\",\n \"paymentStatus\": \"OVERPAID\",\n \"documentStatusId\": \"\",\n \"documentStatusName\": \"\",\n \"issued\": \"\",\n \"draft\": \"\",\n \"enabled\": \"\",\n \"verified\": \"\",\n \"documentDate\": \"\",\n \"shippingDate\": \"\",\n \"counterpartyName\": \"\",\n \"counterpartyTaxId\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"companyTaxId\": \"\",\n \"warehouseName\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"optometristId\": \"\",\n \"optometristName\": \"\",\n \"documentTypeId\": \"\",\n \"documentTypeName\": \"\",\n \"paymentTermsId\": \"\",\n \"paymentTermsName\": \"\",\n \"basePriceListId\": \"\",\n \"basePriceListName\": \"\",\n \"discountPriceListId\": \"\",\n \"discountPriceListName\": \"\",\n \"taxBehavior\": \"INCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"withholdingTaxTypeName\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"totalQuantity\": \"\",\n \"grossAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"discountAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"specialDiscountPct\": \"\",\n \"specialDiscountAmount\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"earlyPaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatAmount\": \"\",\n \"surchargeEquivalencePct\": \"\",\n \"surchargeEquivalenceAmount\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"withholdingTaxAmount\": \"\",\n \"shippingAmount\": \"\",\n \"financingPct\": \"\",\n \"financingAmount\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"commercialTotalAmount\": \"\",\n \"total\": \"\",\n \"totalPaid\": \"\",\n \"outstandingAmount\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"currencyDecimals\": \"\",\n \"currencyDecimalsSystem\": \"\",\n \"exchangeRate\": \"\",\n \"grossAmountSystem\": \"\",\n \"discountAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"roundingMode\": \"\",\n \"relationConcept\": \"\",\n \"relationType\": \"\",\n \"linkableQuantity\": \"\",\n \"relationQuantity\": \"\",\n \"totalApprovals\": \"\",\n \"validatedApprovals\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"REPAIR_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"CLAIM\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"RI\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"CP\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"grossAmount\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatPct\": \"\",\n \"vatAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"surchargePct\": \"\",\n \"surchargeAmount\": \"\",\n \"total\": \"\",\n \"commercialTotalAmount\": \"\",\n \"discounts\": [\n {\n \"type\": \"INSURER\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"id\": \"\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n }\n ],\n \"appliedPriceRule\": {\n \"id\": \"\",\n \"ruleType\": \"DISCOUNT\",\n \"tariffId\": \"\",\n \"tariffName\": \"\",\n \"comboId\": \"\",\n \"comboName\": \"\",\n \"purchaseCondition\": \"\",\n \"purchaseConditionId\": \"\",\n \"discountConditionId\": \"\",\n \"discountValue\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ]\n },\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"grossAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"reservedQuantity\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"QUOTE\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"MANUFACTURING_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"opticalOrderId\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"grossAmount\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatPct\": \"\",\n \"vatAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"surchargePct\": \"\",\n \"surchargeAmount\": \"\",\n \"total\": \"\",\n \"commercialTotalAmount\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n },\n {\n \"type\": \"PIN\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n }\n ],\n \"appliedPriceRule\": {\n \"id\": \"\",\n \"ruleType\": \"PIN\",\n \"tariffId\": \"\",\n \"tariffName\": \"\",\n \"comboId\": \"\",\n \"comboName\": \"\",\n \"purchaseCondition\": \"\",\n \"purchaseConditionId\": \"\",\n \"discountConditionId\": \"\",\n \"discountValue\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ]\n },\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"grossAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"reservedQuantity\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"CLAIM\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"REPAIR_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"opticalOrderId\": \"\"\n }\n ],\n \"carrierId\": \"\",\n \"carrierName\": \"\",\n \"carrierTaxId\": \"\",\n \"driverName\": \"\",\n \"vehicleId\": \"\",\n \"vehiclePlate\": \"\",\n \"vehicleModel\": \"\",\n \"shipmentNumber\": \"\",\n \"transportNote\": \"\",\n \"loadingNote\": \"\",\n \"quickReceive\": \"\",\n \"tareWeight\": \"\",\n \"grossWeight\": \"\",\n \"netWeight\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7912b2ec-efc6-4e8a-9dd7-699fefd68c18", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details. Also returned for malformed merge-patch payloads.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales delivery note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fb704cda-a209-41d7-badc-2b30b5676b55", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "sales-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales delivery note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "38649df7-e402-4394-ba54-a126e7af4278", "name": "Authenticated user is missing the `EDITAR_ALBARANESENTREGA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "sales-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales delivery note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c6099292-8a59-4419-8a20-955b58b12dc3", "name": "Sales delivery note not found", "originalRequest": { "url": { "path": [ "api", "v2", "sales-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales delivery note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "13cd5575-aa5c-41c3-bc3d-58020b5adffe", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales delivery note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b205051f-cad3-4e14-91ba-20d508ecfa98", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales delivery note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "7600660c-a7d3-409d-9252-04ee7d148823", "name": "List sales delivery notes", "request": { "name": "List sales delivery notes", "description": { "content": "Returns a paginated list of customer sales delivery notes with envelope `{data, totalCount, skip, limit, hasMore}`. Supports optional RSQL `filter`, `sort` (default `lastModifiedAt:desc`), `skip`/`limit` pagination and `modifiedAfter`/`modifiedBefore` bookends. Limit is capped at 200; skip is clamped to >= 0.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "sales-delivery-notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "baf76088-daca-49bb-aaeb-867282dae94c", "name": "Page of sales delivery notes", "originalRequest": { "url": { "path": [ "api", "v2", "sales-delivery-notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "55e4e18c-4f09-473f-9fbd-00b0391f3575", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "sales-delivery-notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "00d10ad1-b312-426a-a3a9-3e8f4762cb94", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "sales-delivery-notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c62a7bd5-f671-4e66-a211-902fab992e08", "name": "Authenticated user is missing the `VER_ALBARANESENTREGA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "sales-delivery-notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6139e603-cac0-47d4-b7ef-197d9bfb2c69", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-delivery-notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3d48ca21-986e-4d38-8f0e-f7cf9c091daa", "name": "Create sales delivery note", "request": { "name": "Create sales delivery note", "description": { "content": "Creates a new customer sales delivery note with the provided data and optional line items and prepayments. Business logic runs in the legacy WAR via the internal commands gateway.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "sales-delivery-notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"INCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"INVOICE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"carrierId\": \"\",\n \"driverName\": \"\",\n \"vehicleId\": \"\",\n \"vehiclePlate\": \"\",\n \"shipmentNumber\": \"\",\n \"transportNote\": \"\",\n \"loadingNote\": \"\",\n \"tareWeight\": \"\",\n \"grossWeight\": \"\",\n \"netWeight\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "05cf3c7c-22ff-475a-b371-e9cf105cf115", "name": "Sales delivery note created", "originalRequest": { "url": { "path": [ "api", "v2", "sales-delivery-notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"INCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"INVOICE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"carrierId\": \"\",\n \"driverName\": \"\",\n \"vehicleId\": \"\",\n \"vehiclePlate\": \"\",\n \"shipmentNumber\": \"\",\n \"transportNote\": \"\",\n \"loadingNote\": \"\",\n \"tareWeight\": \"\",\n \"grossWeight\": \"\",\n \"netWeight\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"documentType\": \"INVOICE\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"deliveryStatus\": \"EP\",\n \"lifecycleStatus\": \"\",\n \"paymentStatus\": \"OVERPAID\",\n \"documentStatusId\": \"\",\n \"documentStatusName\": \"\",\n \"issued\": \"\",\n \"draft\": \"\",\n \"enabled\": \"\",\n \"verified\": \"\",\n \"documentDate\": \"\",\n \"shippingDate\": \"\",\n \"counterpartyName\": \"\",\n \"counterpartyTaxId\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"companyTaxId\": \"\",\n \"warehouseName\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"optometristId\": \"\",\n \"optometristName\": \"\",\n \"documentTypeId\": \"\",\n \"documentTypeName\": \"\",\n \"paymentTermsId\": \"\",\n \"paymentTermsName\": \"\",\n \"basePriceListId\": \"\",\n \"basePriceListName\": \"\",\n \"discountPriceListId\": \"\",\n \"discountPriceListName\": \"\",\n \"taxBehavior\": \"INCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"withholdingTaxTypeName\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"totalQuantity\": \"\",\n \"grossAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"discountAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"specialDiscountPct\": \"\",\n \"specialDiscountAmount\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"earlyPaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatAmount\": \"\",\n \"surchargeEquivalencePct\": \"\",\n \"surchargeEquivalenceAmount\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"withholdingTaxAmount\": \"\",\n \"shippingAmount\": \"\",\n \"financingPct\": \"\",\n \"financingAmount\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"commercialTotalAmount\": \"\",\n \"total\": \"\",\n \"totalPaid\": \"\",\n \"outstandingAmount\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"currencyDecimals\": \"\",\n \"currencyDecimalsSystem\": \"\",\n \"exchangeRate\": \"\",\n \"grossAmountSystem\": \"\",\n \"discountAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"roundingMode\": \"\",\n \"relationConcept\": \"\",\n \"relationType\": \"\",\n \"linkableQuantity\": \"\",\n \"relationQuantity\": \"\",\n \"totalApprovals\": \"\",\n \"validatedApprovals\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"REPAIR_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"CLAIM\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"RI\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"CP\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"grossAmount\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatPct\": \"\",\n \"vatAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"surchargePct\": \"\",\n \"surchargeAmount\": \"\",\n \"total\": \"\",\n \"commercialTotalAmount\": \"\",\n \"discounts\": [\n {\n \"type\": \"INSURER\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"id\": \"\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n }\n ],\n \"appliedPriceRule\": {\n \"id\": \"\",\n \"ruleType\": \"DISCOUNT\",\n \"tariffId\": \"\",\n \"tariffName\": \"\",\n \"comboId\": \"\",\n \"comboName\": \"\",\n \"purchaseCondition\": \"\",\n \"purchaseConditionId\": \"\",\n \"discountConditionId\": \"\",\n \"discountValue\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ]\n },\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"grossAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"reservedQuantity\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"QUOTE\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"MANUFACTURING_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"opticalOrderId\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"grossAmount\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatPct\": \"\",\n \"vatAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"surchargePct\": \"\",\n \"surchargeAmount\": \"\",\n \"total\": \"\",\n \"commercialTotalAmount\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n },\n {\n \"type\": \"PIN\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n }\n ],\n \"appliedPriceRule\": {\n \"id\": \"\",\n \"ruleType\": \"PIN\",\n \"tariffId\": \"\",\n \"tariffName\": \"\",\n \"comboId\": \"\",\n \"comboName\": \"\",\n \"purchaseCondition\": \"\",\n \"purchaseConditionId\": \"\",\n \"discountConditionId\": \"\",\n \"discountValue\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ]\n },\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"grossAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"reservedQuantity\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"CLAIM\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"REPAIR_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"opticalOrderId\": \"\"\n }\n ],\n \"carrierId\": \"\",\n \"carrierName\": \"\",\n \"carrierTaxId\": \"\",\n \"driverName\": \"\",\n \"vehicleId\": \"\",\n \"vehiclePlate\": \"\",\n \"vehicleModel\": \"\",\n \"shipmentNumber\": \"\",\n \"transportNote\": \"\",\n \"loadingNote\": \"\",\n \"quickReceive\": \"\",\n \"tareWeight\": \"\",\n \"grossWeight\": \"\",\n \"netWeight\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f4d9d78c-99d8-4af5-a05f-94e026db7739", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-delivery-notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"INCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"INVOICE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"carrierId\": \"\",\n \"driverName\": \"\",\n \"vehicleId\": \"\",\n \"vehiclePlate\": \"\",\n \"shipmentNumber\": \"\",\n \"transportNote\": \"\",\n \"loadingNote\": \"\",\n \"tareWeight\": \"\",\n \"grossWeight\": \"\",\n \"netWeight\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a45189c8-3879-4d61-928f-d2ea4a876cc7", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "sales-delivery-notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"INCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"INVOICE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"carrierId\": \"\",\n \"driverName\": \"\",\n \"vehicleId\": \"\",\n \"vehiclePlate\": \"\",\n \"shipmentNumber\": \"\",\n \"transportNote\": \"\",\n \"loadingNote\": \"\",\n \"tareWeight\": \"\",\n \"grossWeight\": \"\",\n \"netWeight\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "44e2ed8d-3da4-4423-b5a1-8f4748955e3f", "name": "Authenticated user is missing the `CREAR_ALBARANESENTREGA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "sales-delivery-notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"INCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"INVOICE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"carrierId\": \"\",\n \"driverName\": \"\",\n \"vehicleId\": \"\",\n \"vehiclePlate\": \"\",\n \"shipmentNumber\": \"\",\n \"transportNote\": \"\",\n \"loadingNote\": \"\",\n \"tareWeight\": \"\",\n \"grossWeight\": \"\",\n \"netWeight\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5282783c-283d-48f3-a4b3-5cfbd4ea67c5", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-delivery-notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"INCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"INVOICE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"carrierId\": \"\",\n \"driverName\": \"\",\n \"vehicleId\": \"\",\n \"vehiclePlate\": \"\",\n \"shipmentNumber\": \"\",\n \"transportNote\": \"\",\n \"loadingNote\": \"\",\n \"tareWeight\": \"\",\n \"grossWeight\": \"\",\n \"netWeight\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "sales-credit-notes", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "a3514505-cd82-4256-842e-6fe18d7f834f", "name": "Get sales credit note by ID", "request": { "name": "Get sales credit note by ID", "description": { "content": "Returns a single customer sales credit note by its primary key. Returns `404` if the id refers to a regular (non-corrective) invoice.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "sales-credit-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Sales credit note ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "afa98974-287d-47e9-84e0-ffe3dbaee7cc", "name": "Sales credit note found", "originalRequest": { "url": { "path": [ "api", "v2", "sales-credit-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales credit note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"counterpartyId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"grossAmount\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatPct\": \"\",\n \"vatAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"surchargePct\": \"\",\n \"surchargeAmount\": \"\",\n \"total\": \"\",\n \"commercialTotalAmount\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n }\n ],\n \"appliedPriceRule\": {\n \"id\": \"\",\n \"ruleType\": \"COMBO\",\n \"tariffId\": \"\",\n \"tariffName\": \"\",\n \"comboId\": \"\",\n \"comboName\": \"\",\n \"purchaseCondition\": \"\",\n \"purchaseConditionId\": \"\",\n \"discountConditionId\": \"\",\n \"discountValue\": \"\",\n \"categoryIds\": [\n \"\"\n ]\n },\n \"excludedTariffIds\": [\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"grossAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"reservedQuantity\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"PURCHASE_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"opticalOrderId\": \"\",\n \"deliveryStatus\": \"\",\n \"sunatUnitOfMeasure\": \"NIU\"\n }\n ],\n \"warehouseId\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"documentType\": \"INVOICE\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"deliveryStatus\": \"EP\",\n \"lifecycleStatus\": \"\",\n \"paymentStatus\": \"UNPAID\",\n \"documentStatusId\": \"\",\n \"documentStatusName\": \"\",\n \"issued\": \"\",\n \"draft\": \"\",\n \"enabled\": \"\",\n \"verified\": \"\",\n \"documentDate\": \"\",\n \"shippingDate\": \"\",\n \"counterpartyName\": \"\",\n \"counterpartyTaxId\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"companyTaxId\": \"\",\n \"warehouseName\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"optometristId\": \"\",\n \"optometristName\": \"\",\n \"documentTypeId\": \"\",\n \"documentTypeName\": \"\",\n \"paymentTermsId\": \"\",\n \"paymentTermsName\": \"\",\n \"basePriceListId\": \"\",\n \"basePriceListName\": \"\",\n \"discountPriceListId\": \"\",\n \"discountPriceListName\": \"\",\n \"taxBehavior\": \"EXEMPT\",\n \"withholdingTaxTypeId\": \"\",\n \"withholdingTaxTypeName\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"totalQuantity\": \"\",\n \"grossAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"discountAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"specialDiscountPct\": \"\",\n \"specialDiscountAmount\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"earlyPaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatAmount\": \"\",\n \"surchargeEquivalencePct\": \"\",\n \"surchargeEquivalenceAmount\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"withholdingTaxAmount\": \"\",\n \"shippingAmount\": \"\",\n \"financingPct\": \"\",\n \"financingAmount\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"commercialTotalAmount\": \"\",\n \"total\": \"\",\n \"totalPaid\": \"\",\n \"outstandingAmount\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"currencyDecimals\": \"\",\n \"currencyDecimalsSystem\": \"\",\n \"exchangeRate\": \"\",\n \"grossAmountSystem\": \"\",\n \"discountAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"roundingMode\": \"\",\n \"relationConcept\": \"\",\n \"relationType\": \"\",\n \"linkableQuantity\": \"\",\n \"relationQuantity\": \"\",\n \"totalApprovals\": \"\",\n \"validatedApprovals\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"QUOTE\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"RI\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"pricesIncludeTax\": \"\",\n \"generateDeliveryNote\": \"\",\n \"issueDate\": \"\",\n \"accountingDate\": \"\",\n \"receptionDate\": \"\",\n \"counterpartyType\": \"CC\",\n \"totalWithholdings\": \"\",\n \"accountingNumber\": \"\",\n \"journalEntryId\": \"\",\n \"accountingLedger\": \"\",\n \"linkedToAccounting\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"withholdingTaxAccountId\": \"\",\n \"withholdingTaxAccountName\": \"\",\n \"activityId\": \"\",\n \"activityName\": \"\",\n \"invoiceType\": \"SUB\",\n \"simplified\": \"\",\n \"creditNoteType\": \"\",\n \"saleCondition\": \"\",\n \"reverseCharge\": \"\",\n \"intraCommunity\": \"\",\n \"insuranceInvoice\": \"\",\n \"visitReasonId\": \"\",\n \"visitReasonName\": \"\",\n \"primaryInsurerId\": \"\",\n \"primaryInsurerName\": \"\",\n \"secondaryInsurerId\": \"\",\n \"secondaryInsurerName\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"tertiaryInsurerName\": \"\",\n \"primaryContractNumber\": \"\",\n \"secondaryContractNumber\": \"\",\n \"tertiaryContractNumber\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insuredPartyId\": \"\",\n \"insuredPartyName\": \"\",\n \"insuredNationalId\": \"\",\n \"insuredPolicyNumber\": \"\",\n \"insuredClaimNumber\": \"\",\n \"pointsWalletId\": \"\",\n \"pointsWalletToRedeemId\": \"\",\n \"customerPointsBalance\": \"\",\n \"pointsEarned\": \"\",\n \"pointsRedeemed\": \"\",\n \"pointsValueAmount\": \"\",\n \"opticalDataId\": \"\",\n \"discountPinId\": \"\",\n \"claimId\": \"\",\n \"installments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"dueDate\": \"\",\n \"paid\": \"\",\n \"issued\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"paymentId\": \"\",\n \"withholdingLineId\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"withholdingTaxPct\": \"\"\n }\n ],\n \"totalInstallments\": \"\",\n \"paidInstallments\": \"\",\n \"electronicInvoice\": {\n \"id\": \"\",\n \"signStatus\": \"SUBMIT_ERROR\",\n \"signedAt\": \"\",\n \"lastSignErrorCode\": \"\",\n \"lastSignErrorMessage\": \"\",\n \"sunatHash\": \"\",\n \"sunatInvoiceCode\": \"\",\n \"sunatQrCode\": \"\",\n \"dgiCufe\": \"\",\n \"dgiAuthorizationNumber\": \"\",\n \"dgiSecNumber\": \"\",\n \"dgiDv\": \"\",\n \"dgiQrCode\": \"\",\n \"dgiSystemRef\": \"\"\n },\n \"verifactuStatus\": \"\",\n \"verifactuReady\": \"\",\n \"cfdiUsage\": \"\",\n \"satPaymentMethod\": \"\",\n \"cancellationRecordId\": \"\",\n \"folioNumber\": \"\",\n \"establishmentCode\": \"\",\n \"emissionPointCode\": \"\",\n \"authorizationCode\": \"\",\n \"global\": \"\",\n \"globalInvoiceId\": \"\",\n \"fiscalDocumentNumber\": \"\",\n \"fiscalPrinterSerial\": \"\",\n \"sunatPaymentMethod\": \"CO\",\n \"capabilities\": {\n \"header\": {\n \"allowed\": \"\",\n \"code\": \"VERIFACTU_STATE\",\n \"reason\": \"\"\n },\n \"counterparty\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"documentDate\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"internalFields\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"amounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"unitPrices\": {\n \"allowed\": \"\",\n \"code\": \"VERIFACTU_STATE\",\n \"reason\": \"\"\n },\n \"manualDiscounts\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"lineDescriptions\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"products\": {\n \"allowed\": \"\",\n \"code\": \"VERIFACTU_STATE\",\n \"reason\": \"\"\n },\n \"quantities\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"accounting\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"payments\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"insurerAmounts\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"costCenters\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"opticalOrders\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"edit\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"delete\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n }\n },\n \"einvoiceError\": \"\",\n \"einvoiceXmlUrl\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f9a7b148-905f-4bb3-aab2-59b693aa0a23", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "sales-credit-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales credit note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d3e58f9f-282a-46bc-ad27-be8917331eaa", "name": "Authenticated user is missing the `VER_FACTURASEMITIDAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "sales-credit-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales credit note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ba3d4d23-f91a-431d-b47e-4185f70fa334", "name": "Sales credit note not found", "originalRequest": { "url": { "path": [ "api", "v2", "sales-credit-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales credit note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0c1da311-770a-4212-a8ed-3165b12f8558", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-credit-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales credit note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9133ad7e-80a7-42a4-95b8-0c6e00353c8a", "name": "Update sales credit note", "request": { "name": "Update sales credit note", "description": { "content": "Full replacement of a customer sales credit note. Send the `If-Match` header with the current ETag for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "sales-credit-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Sales credit note ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"POINTS\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\",\n \"sunatUnitOfMeasure\": \"NIU\"\n }\n ],\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"pricesIncludeTax\": \"\",\n \"generateDeliveryNote\": \"\",\n \"issueDate\": \"\",\n \"accountingDate\": \"\",\n \"receptionDate\": \"\",\n \"counterpartyType\": \"MS\",\n \"accountingLedger\": \"\",\n \"linkedToAccounting\": \"\",\n \"counterpartyAccountId\": \"\",\n \"withholdingTaxAccountId\": \"\",\n \"activityId\": \"\",\n \"simplified\": \"\",\n \"saleCondition\": \"\",\n \"reverseCharge\": \"\",\n \"intraCommunity\": \"\",\n \"insuranceInvoice\": \"\",\n \"visitReasonId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryContractNumber\": \"\",\n \"secondaryContractNumber\": \"\",\n \"tertiaryContractNumber\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insuredPartyId\": \"\",\n \"insuredNationalId\": \"\",\n \"insuredPolicyNumber\": \"\",\n \"insuredClaimNumber\": \"\",\n \"pointsWalletToRedeemId\": \"\",\n \"pointsToRedeem\": \"\",\n \"discountPinId\": \"\",\n \"installments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n }\n ],\n \"electronicInvoice\": {\n \"signStatus\": \"RECEIVED_PENDING\",\n \"signedAt\": \"\",\n \"lastSignErrorCode\": \"\",\n \"lastSignErrorMessage\": \"\",\n \"sunatHash\": \"\",\n \"sunatInvoiceCode\": \"\",\n \"sunatQrCode\": \"\",\n \"dgiCufe\": \"\",\n \"dgiAuthorizationNumber\": \"\",\n \"dgiSecNumber\": \"\",\n \"dgiDv\": \"\",\n \"dgiQrCode\": \"\",\n \"dgiSystemRef\": \"\"\n },\n \"sunatPaymentMethod\": \"CR\",\n \"capabilities\": {\n \"header\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"counterparty\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"documentDate\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"internalFields\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"amounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"unitPrices\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"manualDiscounts\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"lineDescriptions\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"products\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"quantities\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"accounting\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"payments\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"insurerAmounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"costCenters\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"opticalOrders\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"edit\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"delete\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n }\n },\n \"einvoiceError\": \"\",\n \"einvoiceXmlUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "b1ddaa2b-848f-4ffc-9fb6-0b4a21f95ecb", "name": "Sales credit note updated", "originalRequest": { "url": { "path": [ "api", "v2", "sales-credit-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales credit note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"POINTS\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\",\n \"sunatUnitOfMeasure\": \"NIU\"\n }\n ],\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"pricesIncludeTax\": \"\",\n \"generateDeliveryNote\": \"\",\n \"issueDate\": \"\",\n \"accountingDate\": \"\",\n \"receptionDate\": \"\",\n \"counterpartyType\": \"MS\",\n \"accountingLedger\": \"\",\n \"linkedToAccounting\": \"\",\n \"counterpartyAccountId\": \"\",\n \"withholdingTaxAccountId\": \"\",\n \"activityId\": \"\",\n \"simplified\": \"\",\n \"saleCondition\": \"\",\n \"reverseCharge\": \"\",\n \"intraCommunity\": \"\",\n \"insuranceInvoice\": \"\",\n \"visitReasonId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryContractNumber\": \"\",\n \"secondaryContractNumber\": \"\",\n \"tertiaryContractNumber\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insuredPartyId\": \"\",\n \"insuredNationalId\": \"\",\n \"insuredPolicyNumber\": \"\",\n \"insuredClaimNumber\": \"\",\n \"pointsWalletToRedeemId\": \"\",\n \"pointsToRedeem\": \"\",\n \"discountPinId\": \"\",\n \"installments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n }\n ],\n \"electronicInvoice\": {\n \"signStatus\": \"RECEIVED_PENDING\",\n \"signedAt\": \"\",\n \"lastSignErrorCode\": \"\",\n \"lastSignErrorMessage\": \"\",\n \"sunatHash\": \"\",\n \"sunatInvoiceCode\": \"\",\n \"sunatQrCode\": \"\",\n \"dgiCufe\": \"\",\n \"dgiAuthorizationNumber\": \"\",\n \"dgiSecNumber\": \"\",\n \"dgiDv\": \"\",\n \"dgiQrCode\": \"\",\n \"dgiSystemRef\": \"\"\n },\n \"sunatPaymentMethod\": \"CR\",\n \"capabilities\": {\n \"header\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"counterparty\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"documentDate\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"internalFields\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"amounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"unitPrices\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"manualDiscounts\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"lineDescriptions\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"products\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"quantities\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"accounting\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"payments\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"insurerAmounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"costCenters\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"opticalOrders\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"edit\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"delete\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n }\n },\n \"einvoiceError\": \"\",\n \"einvoiceXmlUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"counterpartyId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"grossAmount\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatPct\": \"\",\n \"vatAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"surchargePct\": \"\",\n \"surchargeAmount\": \"\",\n \"total\": \"\",\n \"commercialTotalAmount\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n }\n ],\n \"appliedPriceRule\": {\n \"id\": \"\",\n \"ruleType\": \"COMBO\",\n \"tariffId\": \"\",\n \"tariffName\": \"\",\n \"comboId\": \"\",\n \"comboName\": \"\",\n \"purchaseCondition\": \"\",\n \"purchaseConditionId\": \"\",\n \"discountConditionId\": \"\",\n \"discountValue\": \"\",\n \"categoryIds\": [\n \"\"\n ]\n },\n \"excludedTariffIds\": [\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"grossAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"reservedQuantity\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"PURCHASE_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"opticalOrderId\": \"\",\n \"deliveryStatus\": \"\",\n \"sunatUnitOfMeasure\": \"NIU\"\n }\n ],\n \"warehouseId\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"documentType\": \"INVOICE\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"deliveryStatus\": \"EP\",\n \"lifecycleStatus\": \"\",\n \"paymentStatus\": \"UNPAID\",\n \"documentStatusId\": \"\",\n \"documentStatusName\": \"\",\n \"issued\": \"\",\n \"draft\": \"\",\n \"enabled\": \"\",\n \"verified\": \"\",\n \"documentDate\": \"\",\n \"shippingDate\": \"\",\n \"counterpartyName\": \"\",\n \"counterpartyTaxId\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"companyTaxId\": \"\",\n \"warehouseName\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"optometristId\": \"\",\n \"optometristName\": \"\",\n \"documentTypeId\": \"\",\n \"documentTypeName\": \"\",\n \"paymentTermsId\": \"\",\n \"paymentTermsName\": \"\",\n \"basePriceListId\": \"\",\n \"basePriceListName\": \"\",\n \"discountPriceListId\": \"\",\n \"discountPriceListName\": \"\",\n \"taxBehavior\": \"EXEMPT\",\n \"withholdingTaxTypeId\": \"\",\n \"withholdingTaxTypeName\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"totalQuantity\": \"\",\n \"grossAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"discountAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"specialDiscountPct\": \"\",\n \"specialDiscountAmount\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"earlyPaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatAmount\": \"\",\n \"surchargeEquivalencePct\": \"\",\n \"surchargeEquivalenceAmount\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"withholdingTaxAmount\": \"\",\n \"shippingAmount\": \"\",\n \"financingPct\": \"\",\n \"financingAmount\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"commercialTotalAmount\": \"\",\n \"total\": \"\",\n \"totalPaid\": \"\",\n \"outstandingAmount\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"currencyDecimals\": \"\",\n \"currencyDecimalsSystem\": \"\",\n \"exchangeRate\": \"\",\n \"grossAmountSystem\": \"\",\n \"discountAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"roundingMode\": \"\",\n \"relationConcept\": \"\",\n \"relationType\": \"\",\n \"linkableQuantity\": \"\",\n \"relationQuantity\": \"\",\n \"totalApprovals\": \"\",\n \"validatedApprovals\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"QUOTE\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"RI\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"pricesIncludeTax\": \"\",\n \"generateDeliveryNote\": \"\",\n \"issueDate\": \"\",\n \"accountingDate\": \"\",\n \"receptionDate\": \"\",\n \"counterpartyType\": \"CC\",\n \"totalWithholdings\": \"\",\n \"accountingNumber\": \"\",\n \"journalEntryId\": \"\",\n \"accountingLedger\": \"\",\n \"linkedToAccounting\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"withholdingTaxAccountId\": \"\",\n \"withholdingTaxAccountName\": \"\",\n \"activityId\": \"\",\n \"activityName\": \"\",\n \"invoiceType\": \"SUB\",\n \"simplified\": \"\",\n \"creditNoteType\": \"\",\n \"saleCondition\": \"\",\n \"reverseCharge\": \"\",\n \"intraCommunity\": \"\",\n \"insuranceInvoice\": \"\",\n \"visitReasonId\": \"\",\n \"visitReasonName\": \"\",\n \"primaryInsurerId\": \"\",\n \"primaryInsurerName\": \"\",\n \"secondaryInsurerId\": \"\",\n \"secondaryInsurerName\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"tertiaryInsurerName\": \"\",\n \"primaryContractNumber\": \"\",\n \"secondaryContractNumber\": \"\",\n \"tertiaryContractNumber\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insuredPartyId\": \"\",\n \"insuredPartyName\": \"\",\n \"insuredNationalId\": \"\",\n \"insuredPolicyNumber\": \"\",\n \"insuredClaimNumber\": \"\",\n \"pointsWalletId\": \"\",\n \"pointsWalletToRedeemId\": \"\",\n \"customerPointsBalance\": \"\",\n \"pointsEarned\": \"\",\n \"pointsRedeemed\": \"\",\n \"pointsValueAmount\": \"\",\n \"opticalDataId\": \"\",\n \"discountPinId\": \"\",\n \"claimId\": \"\",\n \"installments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"dueDate\": \"\",\n \"paid\": \"\",\n \"issued\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"paymentId\": \"\",\n \"withholdingLineId\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"withholdingTaxPct\": \"\"\n }\n ],\n \"totalInstallments\": \"\",\n \"paidInstallments\": \"\",\n \"electronicInvoice\": {\n \"id\": \"\",\n \"signStatus\": \"SUBMIT_ERROR\",\n \"signedAt\": \"\",\n \"lastSignErrorCode\": \"\",\n \"lastSignErrorMessage\": \"\",\n \"sunatHash\": \"\",\n \"sunatInvoiceCode\": \"\",\n \"sunatQrCode\": \"\",\n \"dgiCufe\": \"\",\n \"dgiAuthorizationNumber\": \"\",\n \"dgiSecNumber\": \"\",\n \"dgiDv\": \"\",\n \"dgiQrCode\": \"\",\n \"dgiSystemRef\": \"\"\n },\n \"verifactuStatus\": \"\",\n \"verifactuReady\": \"\",\n \"cfdiUsage\": \"\",\n \"satPaymentMethod\": \"\",\n \"cancellationRecordId\": \"\",\n \"folioNumber\": \"\",\n \"establishmentCode\": \"\",\n \"emissionPointCode\": \"\",\n \"authorizationCode\": \"\",\n \"global\": \"\",\n \"globalInvoiceId\": \"\",\n \"fiscalDocumentNumber\": \"\",\n \"fiscalPrinterSerial\": \"\",\n \"sunatPaymentMethod\": \"CO\",\n \"capabilities\": {\n \"header\": {\n \"allowed\": \"\",\n \"code\": \"VERIFACTU_STATE\",\n \"reason\": \"\"\n },\n \"counterparty\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"documentDate\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"internalFields\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"amounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"unitPrices\": {\n \"allowed\": \"\",\n \"code\": \"VERIFACTU_STATE\",\n \"reason\": \"\"\n },\n \"manualDiscounts\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"lineDescriptions\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"products\": {\n \"allowed\": \"\",\n \"code\": \"VERIFACTU_STATE\",\n \"reason\": \"\"\n },\n \"quantities\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"accounting\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"payments\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"insurerAmounts\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"costCenters\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"opticalOrders\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"edit\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"delete\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n }\n },\n \"einvoiceError\": \"\",\n \"einvoiceXmlUrl\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fd32a3af-c864-4e59-be2a-f77123d95aa4", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-credit-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales credit note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"POINTS\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\",\n \"sunatUnitOfMeasure\": \"NIU\"\n }\n ],\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"pricesIncludeTax\": \"\",\n \"generateDeliveryNote\": \"\",\n \"issueDate\": \"\",\n \"accountingDate\": \"\",\n \"receptionDate\": \"\",\n \"counterpartyType\": \"MS\",\n \"accountingLedger\": \"\",\n \"linkedToAccounting\": \"\",\n \"counterpartyAccountId\": \"\",\n \"withholdingTaxAccountId\": \"\",\n \"activityId\": \"\",\n \"simplified\": \"\",\n \"saleCondition\": \"\",\n \"reverseCharge\": \"\",\n \"intraCommunity\": \"\",\n \"insuranceInvoice\": \"\",\n \"visitReasonId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryContractNumber\": \"\",\n \"secondaryContractNumber\": \"\",\n \"tertiaryContractNumber\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insuredPartyId\": \"\",\n \"insuredNationalId\": \"\",\n \"insuredPolicyNumber\": \"\",\n \"insuredClaimNumber\": \"\",\n \"pointsWalletToRedeemId\": \"\",\n \"pointsToRedeem\": \"\",\n \"discountPinId\": \"\",\n \"installments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n }\n ],\n \"electronicInvoice\": {\n \"signStatus\": \"RECEIVED_PENDING\",\n \"signedAt\": \"\",\n \"lastSignErrorCode\": \"\",\n \"lastSignErrorMessage\": \"\",\n \"sunatHash\": \"\",\n \"sunatInvoiceCode\": \"\",\n \"sunatQrCode\": \"\",\n \"dgiCufe\": \"\",\n \"dgiAuthorizationNumber\": \"\",\n \"dgiSecNumber\": \"\",\n \"dgiDv\": \"\",\n \"dgiQrCode\": \"\",\n \"dgiSystemRef\": \"\"\n },\n \"sunatPaymentMethod\": \"CR\",\n \"capabilities\": {\n \"header\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"counterparty\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"documentDate\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"internalFields\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"amounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"unitPrices\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"manualDiscounts\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"lineDescriptions\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"products\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"quantities\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"accounting\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"payments\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"insurerAmounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"costCenters\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"opticalOrders\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"edit\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"delete\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n }\n },\n \"einvoiceError\": \"\",\n \"einvoiceXmlUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d88b6718-e616-417c-8a48-6023e5b02b7c", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "sales-credit-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales credit note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"POINTS\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\",\n \"sunatUnitOfMeasure\": \"NIU\"\n }\n ],\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"pricesIncludeTax\": \"\",\n \"generateDeliveryNote\": \"\",\n \"issueDate\": \"\",\n \"accountingDate\": \"\",\n \"receptionDate\": \"\",\n \"counterpartyType\": \"MS\",\n \"accountingLedger\": \"\",\n \"linkedToAccounting\": \"\",\n \"counterpartyAccountId\": \"\",\n \"withholdingTaxAccountId\": \"\",\n \"activityId\": \"\",\n \"simplified\": \"\",\n \"saleCondition\": \"\",\n \"reverseCharge\": \"\",\n \"intraCommunity\": \"\",\n \"insuranceInvoice\": \"\",\n \"visitReasonId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryContractNumber\": \"\",\n \"secondaryContractNumber\": \"\",\n \"tertiaryContractNumber\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insuredPartyId\": \"\",\n \"insuredNationalId\": \"\",\n \"insuredPolicyNumber\": \"\",\n \"insuredClaimNumber\": \"\",\n \"pointsWalletToRedeemId\": \"\",\n \"pointsToRedeem\": \"\",\n \"discountPinId\": \"\",\n \"installments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n }\n ],\n \"electronicInvoice\": {\n \"signStatus\": \"RECEIVED_PENDING\",\n \"signedAt\": \"\",\n \"lastSignErrorCode\": \"\",\n \"lastSignErrorMessage\": \"\",\n \"sunatHash\": \"\",\n \"sunatInvoiceCode\": \"\",\n \"sunatQrCode\": \"\",\n \"dgiCufe\": \"\",\n \"dgiAuthorizationNumber\": \"\",\n \"dgiSecNumber\": \"\",\n \"dgiDv\": \"\",\n \"dgiQrCode\": \"\",\n \"dgiSystemRef\": \"\"\n },\n \"sunatPaymentMethod\": \"CR\",\n \"capabilities\": {\n \"header\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"counterparty\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"documentDate\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"internalFields\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"amounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"unitPrices\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"manualDiscounts\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"lineDescriptions\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"products\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"quantities\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"accounting\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"payments\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"insurerAmounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"costCenters\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"opticalOrders\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"edit\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"delete\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n }\n },\n \"einvoiceError\": \"\",\n \"einvoiceXmlUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cf82bd74-b03f-4e05-9cf3-b64990fb2e7b", "name": "Authenticated user is missing the `EDITAR_FACTURASEMITIDAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "sales-credit-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales credit note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"POINTS\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\",\n \"sunatUnitOfMeasure\": \"NIU\"\n }\n ],\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"pricesIncludeTax\": \"\",\n \"generateDeliveryNote\": \"\",\n \"issueDate\": \"\",\n \"accountingDate\": \"\",\n \"receptionDate\": \"\",\n \"counterpartyType\": \"MS\",\n \"accountingLedger\": \"\",\n \"linkedToAccounting\": \"\",\n \"counterpartyAccountId\": \"\",\n \"withholdingTaxAccountId\": \"\",\n \"activityId\": \"\",\n \"simplified\": \"\",\n \"saleCondition\": \"\",\n \"reverseCharge\": \"\",\n \"intraCommunity\": \"\",\n \"insuranceInvoice\": \"\",\n \"visitReasonId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryContractNumber\": \"\",\n \"secondaryContractNumber\": \"\",\n \"tertiaryContractNumber\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insuredPartyId\": \"\",\n \"insuredNationalId\": \"\",\n \"insuredPolicyNumber\": \"\",\n \"insuredClaimNumber\": \"\",\n \"pointsWalletToRedeemId\": \"\",\n \"pointsToRedeem\": \"\",\n \"discountPinId\": \"\",\n \"installments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n }\n ],\n \"electronicInvoice\": {\n \"signStatus\": \"RECEIVED_PENDING\",\n \"signedAt\": \"\",\n \"lastSignErrorCode\": \"\",\n \"lastSignErrorMessage\": \"\",\n \"sunatHash\": \"\",\n \"sunatInvoiceCode\": \"\",\n \"sunatQrCode\": \"\",\n \"dgiCufe\": \"\",\n \"dgiAuthorizationNumber\": \"\",\n \"dgiSecNumber\": \"\",\n \"dgiDv\": \"\",\n \"dgiQrCode\": \"\",\n \"dgiSystemRef\": \"\"\n },\n \"sunatPaymentMethod\": \"CR\",\n \"capabilities\": {\n \"header\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"counterparty\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"documentDate\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"internalFields\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"amounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"unitPrices\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"manualDiscounts\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"lineDescriptions\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"products\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"quantities\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"accounting\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"payments\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"insurerAmounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"costCenters\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"opticalOrders\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"edit\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"delete\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n }\n },\n \"einvoiceError\": \"\",\n \"einvoiceXmlUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "aeb96938-423c-4c57-9a22-a94c6c4ebe5d", "name": "Sales credit note not found", "originalRequest": { "url": { "path": [ "api", "v2", "sales-credit-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales credit note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"POINTS\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\",\n \"sunatUnitOfMeasure\": \"NIU\"\n }\n ],\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"pricesIncludeTax\": \"\",\n \"generateDeliveryNote\": \"\",\n \"issueDate\": \"\",\n \"accountingDate\": \"\",\n \"receptionDate\": \"\",\n \"counterpartyType\": \"MS\",\n \"accountingLedger\": \"\",\n \"linkedToAccounting\": \"\",\n \"counterpartyAccountId\": \"\",\n \"withholdingTaxAccountId\": \"\",\n \"activityId\": \"\",\n \"simplified\": \"\",\n \"saleCondition\": \"\",\n \"reverseCharge\": \"\",\n \"intraCommunity\": \"\",\n \"insuranceInvoice\": \"\",\n \"visitReasonId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryContractNumber\": \"\",\n \"secondaryContractNumber\": \"\",\n \"tertiaryContractNumber\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insuredPartyId\": \"\",\n \"insuredNationalId\": \"\",\n \"insuredPolicyNumber\": \"\",\n \"insuredClaimNumber\": \"\",\n \"pointsWalletToRedeemId\": \"\",\n \"pointsToRedeem\": \"\",\n \"discountPinId\": \"\",\n \"installments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n }\n ],\n \"electronicInvoice\": {\n \"signStatus\": \"RECEIVED_PENDING\",\n \"signedAt\": \"\",\n \"lastSignErrorCode\": \"\",\n \"lastSignErrorMessage\": \"\",\n \"sunatHash\": \"\",\n \"sunatInvoiceCode\": \"\",\n \"sunatQrCode\": \"\",\n \"dgiCufe\": \"\",\n \"dgiAuthorizationNumber\": \"\",\n \"dgiSecNumber\": \"\",\n \"dgiDv\": \"\",\n \"dgiQrCode\": \"\",\n \"dgiSystemRef\": \"\"\n },\n \"sunatPaymentMethod\": \"CR\",\n \"capabilities\": {\n \"header\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"counterparty\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"documentDate\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"internalFields\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"amounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"unitPrices\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"manualDiscounts\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"lineDescriptions\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"products\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"quantities\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"accounting\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"payments\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"insurerAmounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"costCenters\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"opticalOrders\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"edit\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"delete\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n }\n },\n \"einvoiceError\": \"\",\n \"einvoiceXmlUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b9f8f037-db2e-4c33-bd25-2372d69b03c9", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-credit-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales credit note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"POINTS\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\",\n \"sunatUnitOfMeasure\": \"NIU\"\n }\n ],\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"pricesIncludeTax\": \"\",\n \"generateDeliveryNote\": \"\",\n \"issueDate\": \"\",\n \"accountingDate\": \"\",\n \"receptionDate\": \"\",\n \"counterpartyType\": \"MS\",\n \"accountingLedger\": \"\",\n \"linkedToAccounting\": \"\",\n \"counterpartyAccountId\": \"\",\n \"withholdingTaxAccountId\": \"\",\n \"activityId\": \"\",\n \"simplified\": \"\",\n \"saleCondition\": \"\",\n \"reverseCharge\": \"\",\n \"intraCommunity\": \"\",\n \"insuranceInvoice\": \"\",\n \"visitReasonId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryContractNumber\": \"\",\n \"secondaryContractNumber\": \"\",\n \"tertiaryContractNumber\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insuredPartyId\": \"\",\n \"insuredNationalId\": \"\",\n \"insuredPolicyNumber\": \"\",\n \"insuredClaimNumber\": \"\",\n \"pointsWalletToRedeemId\": \"\",\n \"pointsToRedeem\": \"\",\n \"discountPinId\": \"\",\n \"installments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n }\n ],\n \"electronicInvoice\": {\n \"signStatus\": \"RECEIVED_PENDING\",\n \"signedAt\": \"\",\n \"lastSignErrorCode\": \"\",\n \"lastSignErrorMessage\": \"\",\n \"sunatHash\": \"\",\n \"sunatInvoiceCode\": \"\",\n \"sunatQrCode\": \"\",\n \"dgiCufe\": \"\",\n \"dgiAuthorizationNumber\": \"\",\n \"dgiSecNumber\": \"\",\n \"dgiDv\": \"\",\n \"dgiQrCode\": \"\",\n \"dgiSystemRef\": \"\"\n },\n \"sunatPaymentMethod\": \"CR\",\n \"capabilities\": {\n \"header\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"counterparty\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"documentDate\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"internalFields\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"amounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"unitPrices\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"manualDiscounts\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"lineDescriptions\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"products\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"quantities\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"accounting\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"payments\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"insurerAmounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"costCenters\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"opticalOrders\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"edit\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"delete\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n }\n },\n \"einvoiceError\": \"\",\n \"einvoiceXmlUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "10c93116-bfd7-48fa-9799-81de25984f53", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-credit-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales credit note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"POINTS\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\",\n \"sunatUnitOfMeasure\": \"NIU\"\n }\n ],\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"pricesIncludeTax\": \"\",\n \"generateDeliveryNote\": \"\",\n \"issueDate\": \"\",\n \"accountingDate\": \"\",\n \"receptionDate\": \"\",\n \"counterpartyType\": \"MS\",\n \"accountingLedger\": \"\",\n \"linkedToAccounting\": \"\",\n \"counterpartyAccountId\": \"\",\n \"withholdingTaxAccountId\": \"\",\n \"activityId\": \"\",\n \"simplified\": \"\",\n \"saleCondition\": \"\",\n \"reverseCharge\": \"\",\n \"intraCommunity\": \"\",\n \"insuranceInvoice\": \"\",\n \"visitReasonId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryContractNumber\": \"\",\n \"secondaryContractNumber\": \"\",\n \"tertiaryContractNumber\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insuredPartyId\": \"\",\n \"insuredNationalId\": \"\",\n \"insuredPolicyNumber\": \"\",\n \"insuredClaimNumber\": \"\",\n \"pointsWalletToRedeemId\": \"\",\n \"pointsToRedeem\": \"\",\n \"discountPinId\": \"\",\n \"installments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n }\n ],\n \"electronicInvoice\": {\n \"signStatus\": \"RECEIVED_PENDING\",\n \"signedAt\": \"\",\n \"lastSignErrorCode\": \"\",\n \"lastSignErrorMessage\": \"\",\n \"sunatHash\": \"\",\n \"sunatInvoiceCode\": \"\",\n \"sunatQrCode\": \"\",\n \"dgiCufe\": \"\",\n \"dgiAuthorizationNumber\": \"\",\n \"dgiSecNumber\": \"\",\n \"dgiDv\": \"\",\n \"dgiQrCode\": \"\",\n \"dgiSystemRef\": \"\"\n },\n \"sunatPaymentMethod\": \"CR\",\n \"capabilities\": {\n \"header\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"counterparty\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"documentDate\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"internalFields\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"amounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"unitPrices\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"manualDiscounts\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"lineDescriptions\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"products\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"quantities\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"accounting\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"payments\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"insurerAmounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"costCenters\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"opticalOrders\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"edit\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"delete\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n }\n },\n \"einvoiceError\": \"\",\n \"einvoiceXmlUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "19e4c105-8249-42e8-9316-87a5317d131e", "name": "Delete sales credit note", "request": { "name": "Delete sales credit note", "description": { "content": "Deletes a customer sales credit note. Send the `If-Match` header with the current ETag for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "sales-credit-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Sales credit note ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "cea080e1-9730-4e68-be76-04a1ca3337d5", "name": "Sales credit note deleted", "originalRequest": { "url": { "path": [ "api", "v2", "sales-credit-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales credit note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bf02da7e-22f4-4446-b8e3-2494fe094457", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "sales-credit-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales credit note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e0053fb0-bc91-4ea8-956b-b0c62d6020c7", "name": "Authenticated user is missing the `BORRAR_FACTURASEMITIDAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "sales-credit-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales credit note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cdd74f32-1fee-498b-9434-5f04b856ac01", "name": "Sales credit note not found", "originalRequest": { "url": { "path": [ "api", "v2", "sales-credit-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales credit note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9b687e94-5af0-47fb-af61-14acf186f458", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-credit-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales credit note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e880e922-122d-4e63-a67d-120476a92f56", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-credit-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Sales credit note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "81b47c33-6a97-4fbb-97ce-04fdfa023418", "name": "List sales credit notes", "request": { "name": "List sales credit notes", "description": { "content": "Returns a paginated list of customer sales credit notes with envelope `{data, totalCount, skip, limit, hasMore}`. Internally these are invoices with `creditNote=true`; the discriminator is pre-applied and any user RSQL `filter` is ANDed on top.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "sales-credit-notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Additional RSQL filter, ANDed with the implicit `creditNote==true` discriminator. RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "3affbbab-b191-4086-94e0-9e20798dc091", "name": "Page of sales credit notes", "originalRequest": { "url": { "path": [ "api", "v2", "sales-credit-notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Additional RSQL filter, ANDed with the implicit `creditNote==true` discriminator. RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cf4b2655-d918-451f-a35a-8c793db857d5", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "sales-credit-notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Additional RSQL filter, ANDed with the implicit `creditNote==true` discriminator. RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fecb9c6f-e5ab-4541-9c1d-1e13f9869579", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "sales-credit-notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Additional RSQL filter, ANDed with the implicit `creditNote==true` discriminator. RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "83785495-ce75-4c3c-b4bf-c3baadab98b0", "name": "Authenticated user is missing the `VER_FACTURASEMITIDAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "sales-credit-notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Additional RSQL filter, ANDed with the implicit `creditNote==true` discriminator. RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e2451430-4fe1-4a3d-b7b6-23f90d576d5f", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-credit-notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Additional RSQL filter, ANDed with the implicit `creditNote==true` discriminator. RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8359e14d-74dc-44ec-8edf-bf387b1cd0fd", "name": "Create sales credit note", "request": { "name": "Create sales credit note", "description": { "content": "Creates a customer sales credit note linked to an existing sales invoice. The `rectifiedInvoiceId` field is required. The WAR forces the `corrective` / `creditNote` discriminators on the Factura.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "sales-credit-notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"POINTS\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\",\n \"sunatUnitOfMeasure\": \"NIU\"\n }\n ],\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"pricesIncludeTax\": \"\",\n \"generateDeliveryNote\": \"\",\n \"issueDate\": \"\",\n \"accountingDate\": \"\",\n \"receptionDate\": \"\",\n \"counterpartyType\": \"MS\",\n \"accountingLedger\": \"\",\n \"linkedToAccounting\": \"\",\n \"counterpartyAccountId\": \"\",\n \"withholdingTaxAccountId\": \"\",\n \"activityId\": \"\",\n \"simplified\": \"\",\n \"saleCondition\": \"\",\n \"reverseCharge\": \"\",\n \"intraCommunity\": \"\",\n \"insuranceInvoice\": \"\",\n \"visitReasonId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryContractNumber\": \"\",\n \"secondaryContractNumber\": \"\",\n \"tertiaryContractNumber\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insuredPartyId\": \"\",\n \"insuredNationalId\": \"\",\n \"insuredPolicyNumber\": \"\",\n \"insuredClaimNumber\": \"\",\n \"pointsWalletToRedeemId\": \"\",\n \"pointsToRedeem\": \"\",\n \"discountPinId\": \"\",\n \"installments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n }\n ],\n \"electronicInvoice\": {\n \"signStatus\": \"RECEIVED_PENDING\",\n \"signedAt\": \"\",\n \"lastSignErrorCode\": \"\",\n \"lastSignErrorMessage\": \"\",\n \"sunatHash\": \"\",\n \"sunatInvoiceCode\": \"\",\n \"sunatQrCode\": \"\",\n \"dgiCufe\": \"\",\n \"dgiAuthorizationNumber\": \"\",\n \"dgiSecNumber\": \"\",\n \"dgiDv\": \"\",\n \"dgiQrCode\": \"\",\n \"dgiSystemRef\": \"\"\n },\n \"sunatPaymentMethod\": \"CR\",\n \"capabilities\": {\n \"header\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"counterparty\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"documentDate\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"internalFields\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"amounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"unitPrices\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"manualDiscounts\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"lineDescriptions\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"products\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"quantities\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"accounting\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"payments\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"insurerAmounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"costCenters\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"opticalOrders\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"edit\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"delete\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n }\n },\n \"einvoiceError\": \"\",\n \"einvoiceXmlUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "ffc34259-4ffe-436a-a54d-4b690cffc42d", "name": "Sales credit note created", "originalRequest": { "url": { "path": [ "api", "v2", "sales-credit-notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"POINTS\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\",\n \"sunatUnitOfMeasure\": \"NIU\"\n }\n ],\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"pricesIncludeTax\": \"\",\n \"generateDeliveryNote\": \"\",\n \"issueDate\": \"\",\n \"accountingDate\": \"\",\n \"receptionDate\": \"\",\n \"counterpartyType\": \"MS\",\n \"accountingLedger\": \"\",\n \"linkedToAccounting\": \"\",\n \"counterpartyAccountId\": \"\",\n \"withholdingTaxAccountId\": \"\",\n \"activityId\": \"\",\n \"simplified\": \"\",\n \"saleCondition\": \"\",\n \"reverseCharge\": \"\",\n \"intraCommunity\": \"\",\n \"insuranceInvoice\": \"\",\n \"visitReasonId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryContractNumber\": \"\",\n \"secondaryContractNumber\": \"\",\n \"tertiaryContractNumber\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insuredPartyId\": \"\",\n \"insuredNationalId\": \"\",\n \"insuredPolicyNumber\": \"\",\n \"insuredClaimNumber\": \"\",\n \"pointsWalletToRedeemId\": \"\",\n \"pointsToRedeem\": \"\",\n \"discountPinId\": \"\",\n \"installments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n }\n ],\n \"electronicInvoice\": {\n \"signStatus\": \"RECEIVED_PENDING\",\n \"signedAt\": \"\",\n \"lastSignErrorCode\": \"\",\n \"lastSignErrorMessage\": \"\",\n \"sunatHash\": \"\",\n \"sunatInvoiceCode\": \"\",\n \"sunatQrCode\": \"\",\n \"dgiCufe\": \"\",\n \"dgiAuthorizationNumber\": \"\",\n \"dgiSecNumber\": \"\",\n \"dgiDv\": \"\",\n \"dgiQrCode\": \"\",\n \"dgiSystemRef\": \"\"\n },\n \"sunatPaymentMethod\": \"CR\",\n \"capabilities\": {\n \"header\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"counterparty\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"documentDate\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"internalFields\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"amounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"unitPrices\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"manualDiscounts\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"lineDescriptions\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"products\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"quantities\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"accounting\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"payments\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"insurerAmounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"costCenters\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"opticalOrders\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"edit\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"delete\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n }\n },\n \"einvoiceError\": \"\",\n \"einvoiceXmlUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"counterpartyId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"grossAmount\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatPct\": \"\",\n \"vatAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"surchargePct\": \"\",\n \"surchargeAmount\": \"\",\n \"total\": \"\",\n \"commercialTotalAmount\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n }\n ],\n \"appliedPriceRule\": {\n \"id\": \"\",\n \"ruleType\": \"COMBO\",\n \"tariffId\": \"\",\n \"tariffName\": \"\",\n \"comboId\": \"\",\n \"comboName\": \"\",\n \"purchaseCondition\": \"\",\n \"purchaseConditionId\": \"\",\n \"discountConditionId\": \"\",\n \"discountValue\": \"\",\n \"categoryIds\": [\n \"\"\n ]\n },\n \"excludedTariffIds\": [\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"grossAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"reservedQuantity\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"PURCHASE_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"opticalOrderId\": \"\",\n \"deliveryStatus\": \"\",\n \"sunatUnitOfMeasure\": \"NIU\"\n }\n ],\n \"warehouseId\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"documentType\": \"INVOICE\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"deliveryStatus\": \"EP\",\n \"lifecycleStatus\": \"\",\n \"paymentStatus\": \"UNPAID\",\n \"documentStatusId\": \"\",\n \"documentStatusName\": \"\",\n \"issued\": \"\",\n \"draft\": \"\",\n \"enabled\": \"\",\n \"verified\": \"\",\n \"documentDate\": \"\",\n \"shippingDate\": \"\",\n \"counterpartyName\": \"\",\n \"counterpartyTaxId\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"companyTaxId\": \"\",\n \"warehouseName\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"optometristId\": \"\",\n \"optometristName\": \"\",\n \"documentTypeId\": \"\",\n \"documentTypeName\": \"\",\n \"paymentTermsId\": \"\",\n \"paymentTermsName\": \"\",\n \"basePriceListId\": \"\",\n \"basePriceListName\": \"\",\n \"discountPriceListId\": \"\",\n \"discountPriceListName\": \"\",\n \"taxBehavior\": \"EXEMPT\",\n \"withholdingTaxTypeId\": \"\",\n \"withholdingTaxTypeName\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"totalQuantity\": \"\",\n \"grossAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"discountAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"specialDiscountPct\": \"\",\n \"specialDiscountAmount\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"earlyPaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatAmount\": \"\",\n \"surchargeEquivalencePct\": \"\",\n \"surchargeEquivalenceAmount\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"withholdingTaxAmount\": \"\",\n \"shippingAmount\": \"\",\n \"financingPct\": \"\",\n \"financingAmount\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"commercialTotalAmount\": \"\",\n \"total\": \"\",\n \"totalPaid\": \"\",\n \"outstandingAmount\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"currencyDecimals\": \"\",\n \"currencyDecimalsSystem\": \"\",\n \"exchangeRate\": \"\",\n \"grossAmountSystem\": \"\",\n \"discountAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"roundingMode\": \"\",\n \"relationConcept\": \"\",\n \"relationType\": \"\",\n \"linkableQuantity\": \"\",\n \"relationQuantity\": \"\",\n \"totalApprovals\": \"\",\n \"validatedApprovals\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"QUOTE\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"RI\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"pricesIncludeTax\": \"\",\n \"generateDeliveryNote\": \"\",\n \"issueDate\": \"\",\n \"accountingDate\": \"\",\n \"receptionDate\": \"\",\n \"counterpartyType\": \"CC\",\n \"totalWithholdings\": \"\",\n \"accountingNumber\": \"\",\n \"journalEntryId\": \"\",\n \"accountingLedger\": \"\",\n \"linkedToAccounting\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"withholdingTaxAccountId\": \"\",\n \"withholdingTaxAccountName\": \"\",\n \"activityId\": \"\",\n \"activityName\": \"\",\n \"invoiceType\": \"SUB\",\n \"simplified\": \"\",\n \"creditNoteType\": \"\",\n \"saleCondition\": \"\",\n \"reverseCharge\": \"\",\n \"intraCommunity\": \"\",\n \"insuranceInvoice\": \"\",\n \"visitReasonId\": \"\",\n \"visitReasonName\": \"\",\n \"primaryInsurerId\": \"\",\n \"primaryInsurerName\": \"\",\n \"secondaryInsurerId\": \"\",\n \"secondaryInsurerName\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"tertiaryInsurerName\": \"\",\n \"primaryContractNumber\": \"\",\n \"secondaryContractNumber\": \"\",\n \"tertiaryContractNumber\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insuredPartyId\": \"\",\n \"insuredPartyName\": \"\",\n \"insuredNationalId\": \"\",\n \"insuredPolicyNumber\": \"\",\n \"insuredClaimNumber\": \"\",\n \"pointsWalletId\": \"\",\n \"pointsWalletToRedeemId\": \"\",\n \"customerPointsBalance\": \"\",\n \"pointsEarned\": \"\",\n \"pointsRedeemed\": \"\",\n \"pointsValueAmount\": \"\",\n \"opticalDataId\": \"\",\n \"discountPinId\": \"\",\n \"claimId\": \"\",\n \"installments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"dueDate\": \"\",\n \"paid\": \"\",\n \"issued\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"paymentId\": \"\",\n \"withholdingLineId\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"withholdingTaxPct\": \"\"\n }\n ],\n \"totalInstallments\": \"\",\n \"paidInstallments\": \"\",\n \"electronicInvoice\": {\n \"id\": \"\",\n \"signStatus\": \"SUBMIT_ERROR\",\n \"signedAt\": \"\",\n \"lastSignErrorCode\": \"\",\n \"lastSignErrorMessage\": \"\",\n \"sunatHash\": \"\",\n \"sunatInvoiceCode\": \"\",\n \"sunatQrCode\": \"\",\n \"dgiCufe\": \"\",\n \"dgiAuthorizationNumber\": \"\",\n \"dgiSecNumber\": \"\",\n \"dgiDv\": \"\",\n \"dgiQrCode\": \"\",\n \"dgiSystemRef\": \"\"\n },\n \"verifactuStatus\": \"\",\n \"verifactuReady\": \"\",\n \"cfdiUsage\": \"\",\n \"satPaymentMethod\": \"\",\n \"cancellationRecordId\": \"\",\n \"folioNumber\": \"\",\n \"establishmentCode\": \"\",\n \"emissionPointCode\": \"\",\n \"authorizationCode\": \"\",\n \"global\": \"\",\n \"globalInvoiceId\": \"\",\n \"fiscalDocumentNumber\": \"\",\n \"fiscalPrinterSerial\": \"\",\n \"sunatPaymentMethod\": \"CO\",\n \"capabilities\": {\n \"header\": {\n \"allowed\": \"\",\n \"code\": \"VERIFACTU_STATE\",\n \"reason\": \"\"\n },\n \"counterparty\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"documentDate\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"internalFields\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"amounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"unitPrices\": {\n \"allowed\": \"\",\n \"code\": \"VERIFACTU_STATE\",\n \"reason\": \"\"\n },\n \"manualDiscounts\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"lineDescriptions\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"products\": {\n \"allowed\": \"\",\n \"code\": \"VERIFACTU_STATE\",\n \"reason\": \"\"\n },\n \"quantities\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"accounting\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"payments\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"insurerAmounts\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"costCenters\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"opticalOrders\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"edit\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"delete\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n }\n },\n \"einvoiceError\": \"\",\n \"einvoiceXmlUrl\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8ef8fe6e-d907-4928-bfec-1604c47e539e", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details. Common cause: missing `rectifiedInvoiceId`.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-credit-notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"POINTS\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\",\n \"sunatUnitOfMeasure\": \"NIU\"\n }\n ],\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"pricesIncludeTax\": \"\",\n \"generateDeliveryNote\": \"\",\n \"issueDate\": \"\",\n \"accountingDate\": \"\",\n \"receptionDate\": \"\",\n \"counterpartyType\": \"MS\",\n \"accountingLedger\": \"\",\n \"linkedToAccounting\": \"\",\n \"counterpartyAccountId\": \"\",\n \"withholdingTaxAccountId\": \"\",\n \"activityId\": \"\",\n \"simplified\": \"\",\n \"saleCondition\": \"\",\n \"reverseCharge\": \"\",\n \"intraCommunity\": \"\",\n \"insuranceInvoice\": \"\",\n \"visitReasonId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryContractNumber\": \"\",\n \"secondaryContractNumber\": \"\",\n \"tertiaryContractNumber\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insuredPartyId\": \"\",\n \"insuredNationalId\": \"\",\n \"insuredPolicyNumber\": \"\",\n \"insuredClaimNumber\": \"\",\n \"pointsWalletToRedeemId\": \"\",\n \"pointsToRedeem\": \"\",\n \"discountPinId\": \"\",\n \"installments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n }\n ],\n \"electronicInvoice\": {\n \"signStatus\": \"RECEIVED_PENDING\",\n \"signedAt\": \"\",\n \"lastSignErrorCode\": \"\",\n \"lastSignErrorMessage\": \"\",\n \"sunatHash\": \"\",\n \"sunatInvoiceCode\": \"\",\n \"sunatQrCode\": \"\",\n \"dgiCufe\": \"\",\n \"dgiAuthorizationNumber\": \"\",\n \"dgiSecNumber\": \"\",\n \"dgiDv\": \"\",\n \"dgiQrCode\": \"\",\n \"dgiSystemRef\": \"\"\n },\n \"sunatPaymentMethod\": \"CR\",\n \"capabilities\": {\n \"header\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"counterparty\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"documentDate\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"internalFields\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"amounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"unitPrices\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"manualDiscounts\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"lineDescriptions\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"products\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"quantities\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"accounting\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"payments\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"insurerAmounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"costCenters\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"opticalOrders\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"edit\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"delete\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n }\n },\n \"einvoiceError\": \"\",\n \"einvoiceXmlUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8d40f4d0-1bf4-438f-9c7d-49210c965bfc", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "sales-credit-notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"POINTS\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\",\n \"sunatUnitOfMeasure\": \"NIU\"\n }\n ],\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"pricesIncludeTax\": \"\",\n \"generateDeliveryNote\": \"\",\n \"issueDate\": \"\",\n \"accountingDate\": \"\",\n \"receptionDate\": \"\",\n \"counterpartyType\": \"MS\",\n \"accountingLedger\": \"\",\n \"linkedToAccounting\": \"\",\n \"counterpartyAccountId\": \"\",\n \"withholdingTaxAccountId\": \"\",\n \"activityId\": \"\",\n \"simplified\": \"\",\n \"saleCondition\": \"\",\n \"reverseCharge\": \"\",\n \"intraCommunity\": \"\",\n \"insuranceInvoice\": \"\",\n \"visitReasonId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryContractNumber\": \"\",\n \"secondaryContractNumber\": \"\",\n \"tertiaryContractNumber\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insuredPartyId\": \"\",\n \"insuredNationalId\": \"\",\n \"insuredPolicyNumber\": \"\",\n \"insuredClaimNumber\": \"\",\n \"pointsWalletToRedeemId\": \"\",\n \"pointsToRedeem\": \"\",\n \"discountPinId\": \"\",\n \"installments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n }\n ],\n \"electronicInvoice\": {\n \"signStatus\": \"RECEIVED_PENDING\",\n \"signedAt\": \"\",\n \"lastSignErrorCode\": \"\",\n \"lastSignErrorMessage\": \"\",\n \"sunatHash\": \"\",\n \"sunatInvoiceCode\": \"\",\n \"sunatQrCode\": \"\",\n \"dgiCufe\": \"\",\n \"dgiAuthorizationNumber\": \"\",\n \"dgiSecNumber\": \"\",\n \"dgiDv\": \"\",\n \"dgiQrCode\": \"\",\n \"dgiSystemRef\": \"\"\n },\n \"sunatPaymentMethod\": \"CR\",\n \"capabilities\": {\n \"header\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"counterparty\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"documentDate\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"internalFields\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"amounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"unitPrices\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"manualDiscounts\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"lineDescriptions\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"products\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"quantities\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"accounting\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"payments\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"insurerAmounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"costCenters\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"opticalOrders\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"edit\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"delete\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n }\n },\n \"einvoiceError\": \"\",\n \"einvoiceXmlUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a6921520-bced-4399-a1f7-be74d8189ddf", "name": "Authenticated user is missing the `CREAR_FACTURASEMITIDAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "sales-credit-notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"POINTS\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\",\n \"sunatUnitOfMeasure\": \"NIU\"\n }\n ],\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"pricesIncludeTax\": \"\",\n \"generateDeliveryNote\": \"\",\n \"issueDate\": \"\",\n \"accountingDate\": \"\",\n \"receptionDate\": \"\",\n \"counterpartyType\": \"MS\",\n \"accountingLedger\": \"\",\n \"linkedToAccounting\": \"\",\n \"counterpartyAccountId\": \"\",\n \"withholdingTaxAccountId\": \"\",\n \"activityId\": \"\",\n \"simplified\": \"\",\n \"saleCondition\": \"\",\n \"reverseCharge\": \"\",\n \"intraCommunity\": \"\",\n \"insuranceInvoice\": \"\",\n \"visitReasonId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryContractNumber\": \"\",\n \"secondaryContractNumber\": \"\",\n \"tertiaryContractNumber\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insuredPartyId\": \"\",\n \"insuredNationalId\": \"\",\n \"insuredPolicyNumber\": \"\",\n \"insuredClaimNumber\": \"\",\n \"pointsWalletToRedeemId\": \"\",\n \"pointsToRedeem\": \"\",\n \"discountPinId\": \"\",\n \"installments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n }\n ],\n \"electronicInvoice\": {\n \"signStatus\": \"RECEIVED_PENDING\",\n \"signedAt\": \"\",\n \"lastSignErrorCode\": \"\",\n \"lastSignErrorMessage\": \"\",\n \"sunatHash\": \"\",\n \"sunatInvoiceCode\": \"\",\n \"sunatQrCode\": \"\",\n \"dgiCufe\": \"\",\n \"dgiAuthorizationNumber\": \"\",\n \"dgiSecNumber\": \"\",\n \"dgiDv\": \"\",\n \"dgiQrCode\": \"\",\n \"dgiSystemRef\": \"\"\n },\n \"sunatPaymentMethod\": \"CR\",\n \"capabilities\": {\n \"header\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"counterparty\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"documentDate\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"internalFields\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"amounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"unitPrices\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"manualDiscounts\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"lineDescriptions\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"products\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"quantities\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"accounting\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"payments\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"insurerAmounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"costCenters\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"opticalOrders\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"edit\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"delete\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n }\n },\n \"einvoiceError\": \"\",\n \"einvoiceXmlUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "614bc0d3-efd4-4e70-91cc-997f7ef091fe", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "sales-credit-notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"POINTS\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\",\n \"sunatUnitOfMeasure\": \"NIU\"\n }\n ],\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"pricesIncludeTax\": \"\",\n \"generateDeliveryNote\": \"\",\n \"issueDate\": \"\",\n \"accountingDate\": \"\",\n \"receptionDate\": \"\",\n \"counterpartyType\": \"MS\",\n \"accountingLedger\": \"\",\n \"linkedToAccounting\": \"\",\n \"counterpartyAccountId\": \"\",\n \"withholdingTaxAccountId\": \"\",\n \"activityId\": \"\",\n \"simplified\": \"\",\n \"saleCondition\": \"\",\n \"reverseCharge\": \"\",\n \"intraCommunity\": \"\",\n \"insuranceInvoice\": \"\",\n \"visitReasonId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryContractNumber\": \"\",\n \"secondaryContractNumber\": \"\",\n \"tertiaryContractNumber\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insuredPartyId\": \"\",\n \"insuredNationalId\": \"\",\n \"insuredPolicyNumber\": \"\",\n \"insuredClaimNumber\": \"\",\n \"pointsWalletToRedeemId\": \"\",\n \"pointsToRedeem\": \"\",\n \"discountPinId\": \"\",\n \"installments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n }\n ],\n \"electronicInvoice\": {\n \"signStatus\": \"RECEIVED_PENDING\",\n \"signedAt\": \"\",\n \"lastSignErrorCode\": \"\",\n \"lastSignErrorMessage\": \"\",\n \"sunatHash\": \"\",\n \"sunatInvoiceCode\": \"\",\n \"sunatQrCode\": \"\",\n \"dgiCufe\": \"\",\n \"dgiAuthorizationNumber\": \"\",\n \"dgiSecNumber\": \"\",\n \"dgiDv\": \"\",\n \"dgiQrCode\": \"\",\n \"dgiSystemRef\": \"\"\n },\n \"sunatPaymentMethod\": \"CR\",\n \"capabilities\": {\n \"header\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"counterparty\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"documentDate\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"internalFields\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"amounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"unitPrices\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"manualDiscounts\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"lineDescriptions\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"products\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"quantities\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"accounting\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"payments\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"insurerAmounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"costCenters\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"opticalOrders\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"edit\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"delete\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n }\n },\n \"einvoiceError\": \"\",\n \"einvoiceXmlUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "return-causes", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "f5692624-2e05-4128-afc0-5101a6d3251e", "name": "Get return cause by ID", "request": { "name": "Get return cause by ID", "description": { "content": "Returns a single return cause by its primary key.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "return-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Return cause ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "c5bc37e8-b990-473a-9867-89406dccfed4", "name": "Return cause found", "originalRequest": { "url": { "path": [ "api", "v2", "return-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Return cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"allowsItems\": \"\",\n \"requiresClaim\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e4396bf0-3203-498f-b7e6-bba868f7c6bf", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "return-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Return cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0490f240-8eb7-4c11-a069-41130448a46d", "name": "Authenticated user is missing the `VER_CAUSADEVOLUCION` permission", "originalRequest": { "url": { "path": [ "api", "v2", "return-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Return cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f8507775-8d86-4c0c-921a-4e32b32e27fb", "name": "Return cause not found", "originalRequest": { "url": { "path": [ "api", "v2", "return-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Return cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "eeb71cc9-2055-4da8-a799-ed69d725b40d", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "return-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Return cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5db73b44-056f-4986-be69-ef766f38fc89", "name": "Update return cause", "request": { "name": "Update return cause", "description": { "content": "Full replacement of an existing return cause. Send the `If-Match` header for optimistic concurrency (accepted but ignored ÔÇö not versioned).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "return-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Return cause ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"allowsItems\": \"\",\n \"requiresClaim\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "ced29597-ec55-4651-9aa5-35204cad1a1d", "name": "Return cause updated", "originalRequest": { "url": { "path": [ "api", "v2", "return-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Return cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"allowsItems\": \"\",\n \"requiresClaim\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"allowsItems\": \"\",\n \"requiresClaim\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6d747f00-aeaa-43bc-8465-9f7d6d74c0ed", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "return-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Return cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"allowsItems\": \"\",\n \"requiresClaim\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c14d8c16-8283-4f57-ab6a-52d8d5e6ac80", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "return-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Return cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"allowsItems\": \"\",\n \"requiresClaim\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "438fee1e-2dbe-48f1-93db-46642e855631", "name": "Authenticated user is missing the `EDITAR_CAUSADEVOLUCION` permission", "originalRequest": { "url": { "path": [ "api", "v2", "return-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Return cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"allowsItems\": \"\",\n \"requiresClaim\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fdef1dfc-0b73-46e4-ae31-cdd2e3b45e7b", "name": "Return cause not found", "originalRequest": { "url": { "path": [ "api", "v2", "return-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Return cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"allowsItems\": \"\",\n \"requiresClaim\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9c54be4f-8d84-4989-99c2-5bd38f09b25a", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "return-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Return cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"allowsItems\": \"\",\n \"requiresClaim\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "31cebcdd-461d-448a-a76d-77531c003581", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "return-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Return cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"allowsItems\": \"\",\n \"requiresClaim\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7c69ed20-3907-477e-88ec-a5deddc1d445", "name": "Delete return cause", "request": { "name": "Delete return cause", "description": { "content": "Deletes a return cause. Send the `If-Match` header with the current ETag (accepted but ignored ÔÇö not versioned).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "return-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Return cause ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "23614b0d-5057-4864-8cfe-0812a4869169", "name": "Return cause deleted", "originalRequest": { "url": { "path": [ "api", "v2", "return-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Return cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a9a3e8ca-8037-49bd-93bd-4f99df886b02", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "return-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Return cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b653599f-fd1e-4c03-8ed1-70c14eb2fae8", "name": "Authenticated user is missing the `BORRAR_CAUSADEVOLUCION` permission", "originalRequest": { "url": { "path": [ "api", "v2", "return-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Return cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "83ca2d6f-2058-4cf8-a792-8f45ae8d01cd", "name": "Return cause not found", "originalRequest": { "url": { "path": [ "api", "v2", "return-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Return cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0d31d6ef-f79c-4df9-9c24-bc889d24ec85", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "return-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Return cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9738454f-2011-4319-a8a1-94f6ccbd80dd", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "return-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Return cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1022edab-871c-4c18-b6e1-eb3a2efb6a7d", "name": "Merge-patch return cause", "request": { "name": "Merge-patch return cause", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "return-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Return cause ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "c9bcc537-5894-4b05-b40e-ae8f4f0f1ea2", "name": "Return cause patched", "originalRequest": { "url": { "path": [ "api", "v2", "return-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Return cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"allowsItems\": \"\",\n \"requiresClaim\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "be75cc7a-467c-4562-9951-ff712045b1b6", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details. Also returned for malformed merge-patch payloads.", "originalRequest": { "url": { "path": [ "api", "v2", "return-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Return cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f66693d5-b405-45f4-b114-fafc8803aa19", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "return-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Return cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c7e9d527-320a-4403-b8ab-d5708db94403", "name": "Authenticated user is missing the `EDITAR_CAUSADEVOLUCION` permission", "originalRequest": { "url": { "path": [ "api", "v2", "return-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Return cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d9454325-5c0d-45e0-9055-08eca2375c48", "name": "Return cause not found", "originalRequest": { "url": { "path": [ "api", "v2", "return-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Return cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f308a070-23c3-4a8d-b499-7afc053d76df", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "return-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Return cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a840a7bf-185c-45a2-a57d-744e36a037ca", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "return-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Return cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "a054feb1-6e3d-4941-b910-d90d2d2ac55a", "name": "List return causes", "request": { "name": "List return causes", "description": { "content": "Returns a paginated list of return causes with envelope `{data, totalCount, skip, limit, hasMore}`. Supports optional RSQL `filter`, `sort` (default `name:asc`), `skip`/`limit` pagination and `modifiedAfter`/`modifiedBefore` bookends.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "return-causes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "cc9c987a-495e-415e-b656-d485971ffa68", "name": "Page of return causes", "originalRequest": { "url": { "path": [ "api", "v2", "return-causes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "120579e7-5900-4445-95c2-b89128a9bab8", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "return-causes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "20a40eec-9248-4f69-b736-582588c75024", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "return-causes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4862a4ef-9253-407d-a4ad-ec01a114867b", "name": "Authenticated user is missing the `VER_CAUSADEVOLUCION` permission", "originalRequest": { "url": { "path": [ "api", "v2", "return-causes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "346566f6-05ec-43e7-b670-ac067e7a934a", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "return-causes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "305b16a6-c0ff-4945-b2f2-b9eeda3d7e8a", "name": "Create return cause", "request": { "name": "Create return cause", "description": { "content": "Creates a new return cause. Business logic runs in the legacy WAR via the internal commands gateway.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "return-causes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"allowsItems\": \"\",\n \"requiresClaim\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "ac6a1a84-0b7c-4ee0-bc67-e2ea04eea9c1", "name": "Return cause created", "originalRequest": { "url": { "path": [ "api", "v2", "return-causes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"allowsItems\": \"\",\n \"requiresClaim\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"allowsItems\": \"\",\n \"requiresClaim\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0251dc96-888d-4a7e-8bdd-baef45292854", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "return-causes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"allowsItems\": \"\",\n \"requiresClaim\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "da0d7e75-d9ce-47fc-98a0-0bf1147d447d", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "return-causes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"allowsItems\": \"\",\n \"requiresClaim\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b9153072-f3cf-4b59-959e-b44c703d6f95", "name": "Authenticated user is missing the `CREAR_CAUSADEVOLUCION` permission", "originalRequest": { "url": { "path": [ "api", "v2", "return-causes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"allowsItems\": \"\",\n \"requiresClaim\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6bd373e0-b14c-4f37-af7f-1d79d00dd01a", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "return-causes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"allowsItems\": \"\",\n \"requiresClaim\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "new", "description": "", "item": [ { "id": "b3359b45-d851-4b93-b8ee-7d6f530fa04e", "name": "Prototype return cause for a creation form", "request": { "name": "Prototype return cause for a creation form", "description": { "content": "Returns a non-persisted return cause pre-populated with backend defaults (`enabled=true`, current company, next `code`). Optional JSON hints: `companyId`, `copyFromId`. The response has no `id`, `version` or audit fields; call `POST /api/v2/return-causes` afterwards to persist.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "return-causes", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "aca292e6-8596-4aca-92cd-b5f1b58e2a17", "name": "Return cause prototype with defaults", "originalRequest": { "url": { "path": [ "api", "v2", "return-causes", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"allowsItems\": \"\",\n \"requiresClaim\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ee9803fb-931c-40b3-af54-b30a4cffdd06", "name": "Invalid prepare-create hints", "originalRequest": { "url": { "path": [ "api", "v2", "return-causes", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b5649f81-7fce-42e3-a0a4-befdd3a5fc1a", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "return-causes", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "dd0f5654-c3aa-4c6b-8a18-683b2fd58f8c", "name": "Authenticated user is missing the `CREAR_CAUSADEVOLUCION` permission", "originalRequest": { "url": { "path": [ "api", "v2", "return-causes", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f5fc3db2-ab07-4d23-b875-2be44374f348", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "return-causes", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "ranges", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "b24a279f-df8d-4dbd-a56e-32aa1a6bced7", "name": "Get range by ID", "request": { "name": "Get range by ID", "description": { "content": "Returns a single range by its primary key. The response carries a strong `ETag` header with the current version.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "ranges", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Range ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "345b8faa-c344-4a1c-b963-1ba1c92d4259", "name": "Range found", "originalRequest": { "url": { "path": [ "api", "v2", "ranges", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Range ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e72ea5f9-bf99-4f5e-be29-6824a5f7660f", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "ranges", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Range ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b9725dee-9d3b-4f53-9cb8-0d800a347b3d", "name": "Authenticated user is missing the `VER_GAMAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "ranges", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Range ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6dccbbba-68bf-45ba-8ec7-84190e29344c", "name": "Range not found", "originalRequest": { "url": { "path": [ "api", "v2", "ranges", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Range ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3bb7ed58-f87d-4b5f-85ab-58a2d4024812", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "ranges", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Range ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "34418168-5a48-4cbf-8985-30d1cf78a786", "name": "Update range", "request": { "name": "Update range", "description": { "content": "Full replacement of an existing range. Send the `If-Match` header with the current ETag for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "ranges", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Range ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "9853b501-2249-482e-be86-621c8fb3f798", "name": "Range updated", "originalRequest": { "url": { "path": [ "api", "v2", "ranges", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Range ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "427c91fa-25c7-4a5c-9051-4fdec6a50956", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "ranges", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Range ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b497fe5c-44c7-4226-9276-f92a0f1e8b13", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "ranges", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Range ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "eb45132a-e27a-4e0e-8cc3-aa21edcd24a9", "name": "Authenticated user is missing the `EDITAR_GAMAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "ranges", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Range ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9b46a31e-c673-4b4c-97f8-574ddb53b799", "name": "Range not found", "originalRequest": { "url": { "path": [ "api", "v2", "ranges", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Range ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0f987556-217e-499d-b30b-b2e2dfcf98f3", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "ranges", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Range ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1fa57dc0-623f-440b-a27e-5bd7bbd0fd70", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "ranges", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Range ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1b21e037-69d5-4bc6-96ea-2b3652daa2f7", "name": "Delete range", "request": { "name": "Delete range", "description": { "content": "Deletes a range. Send the `If-Match` header with the current ETag for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "ranges", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Range ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "d202ae06-7656-479e-8df6-83293087cccd", "name": "Range deleted", "originalRequest": { "url": { "path": [ "api", "v2", "ranges", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Range ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "72cd0d7c-3efc-4c58-b6c8-b16244770604", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "ranges", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Range ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3cf610c2-1f03-4c06-932a-8587c508b97f", "name": "Authenticated user is missing the `BORRAR_GAMAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "ranges", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Range ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "518faec0-4b14-4129-bb00-3834e24611df", "name": "Range not found", "originalRequest": { "url": { "path": [ "api", "v2", "ranges", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Range ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3f5a13ed-d029-4b86-bb2a-71dd6a5e12ef", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "ranges", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Range ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "69d57273-401d-4785-a69d-ed5b224b56eb", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "ranges", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Range ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8261122f-9088-4bbb-87fd-29548eb68937", "name": "Merge-patch range", "request": { "name": "Merge-patch range", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "ranges", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Range ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "46c6549d-3603-4850-8818-d5970ad01bb6", "name": "Range patched", "originalRequest": { "url": { "path": [ "api", "v2", "ranges", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Range ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "520f9dbe-4822-4da4-8073-d05feb50bf0d", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details. Also returned for malformed merge-patch payloads.", "originalRequest": { "url": { "path": [ "api", "v2", "ranges", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Range ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "47c3621c-921e-40e9-b0dc-1f856d35724f", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "ranges", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Range ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e7e153af-2646-4033-8a97-4becdeb8d5b5", "name": "Authenticated user is missing the `EDITAR_GAMAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "ranges", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Range ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a21bbfbb-3a5f-46bd-86bc-39a4bdf49a11", "name": "Range not found", "originalRequest": { "url": { "path": [ "api", "v2", "ranges", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Range ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9ccb7d32-2f86-4ee6-88ee-8cf0e0f40f29", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "ranges", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Range ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d762ebd6-7598-414a-847e-f36c9f1cd1e5", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "ranges", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Range ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "0b85a831-404c-4b90-bd5b-a815e4ce8203", "name": "List ranges", "request": { "name": "List ranges", "description": { "content": "Returns a paginated list of ranges with envelope `{data, totalCount, skip, limit, hasMore}`. Default sort is `name:asc`. Limit is capped at 200; skip is clamped to >= 0.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "ranges" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "c75e3286-4841-4521-8279-a90de9b75b05", "name": "Page of ranges", "originalRequest": { "url": { "path": [ "api", "v2", "ranges" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "33a69c31-fe67-43f8-8cbb-7581f55f9282", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "ranges" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d7fe3666-dfe6-40a0-bce0-6d188fc724c5", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "ranges" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "40526328-0971-4f94-ba04-8a9af5997c45", "name": "Authenticated user is missing the `VER_GAMAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "ranges" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "18181f1b-e05b-49ea-bf54-02cc6cfb417e", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "ranges" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "56fbb63c-3abb-4da3-a521-5b6c2f4ae5d1", "name": "Create range", "request": { "name": "Create range", "description": { "content": "Creates a new range. Business logic runs in the legacy WAR via the internal commands gateway.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "ranges" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "04135b8d-8f57-416a-a0c8-661d570a8d46", "name": "Range created", "originalRequest": { "url": { "path": [ "api", "v2", "ranges" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "26b922ca-1a11-4b86-aaa9-7f61bad771f5", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "ranges" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c8f3b03b-361f-4f16-a5ed-247a6ccdbcd4", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "ranges" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fe8d4319-2159-4c2d-a69f-71dfb07171da", "name": "Authenticated user is missing the `CREAR_GAMAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "ranges" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "546982ac-d3d8-440b-8bdb-4c1e96998c47", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "ranges" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "new", "description": "", "item": [ { "id": "96ef13cd-a0b4-4943-a275-fa33f0d9a8a0", "name": "Prototype range for a creation form", "request": { "name": "Prototype range for a creation form", "description": { "content": "Returns a non-persisted range pre-populated with backend defaults. Optional hints include `companyId` and `copyFromId`. The response has no `id`, `version` or audit fields; call `POST /api/v2/ranges` afterwards to persist it.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "ranges", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "cd68d0c5-ee09-4352-afb1-abaa7c4b44b0", "name": "Range prototype with defaults", "originalRequest": { "url": { "path": [ "api", "v2", "ranges", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b0b71bb0-1fad-4e90-847a-8ea80663ae42", "name": "Invalid prepare-create hints", "originalRequest": { "url": { "path": [ "api", "v2", "ranges", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a0a50305-1b62-4b29-a351-6e8097144e6e", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "ranges", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "26f1057b-8974-4fc2-a313-2eafd8f99e28", "name": "Authenticated user is missing the `CREAR_GAMAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "ranges", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "33786b24-4d7f-4c1b-9121-38c340c89313", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "ranges", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "purchase-orders", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "5c18cd3d-d243-4b1c-8af9-caea2dfc9ec7", "name": "Get purchase order by ID", "request": { "name": "Get purchase order by ID", "description": { "content": "Returns a single purchase order by its primary key, including line items and payments. Returns 404 when the requested ID belongs to a sales (issued) document.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "purchase-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Purchase order ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "71552356-5d63-4229-bbaa-5979776dbeb5", "name": "Purchase order found", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"documentType\": \"DELIVERY_NOTE\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"deliveryStatus\": \"EP\",\n \"lifecycleStatus\": \"\",\n \"paymentStatus\": \"PAID\",\n \"documentStatusId\": \"\",\n \"documentStatusName\": \"\",\n \"issued\": \"\",\n \"draft\": \"\",\n \"enabled\": \"\",\n \"verified\": \"\",\n \"documentDate\": \"\",\n \"shippingDate\": \"\",\n \"counterpartyName\": \"\",\n \"counterpartyTaxId\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"companyTaxId\": \"\",\n \"warehouseName\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"optometristId\": \"\",\n \"optometristName\": \"\",\n \"documentTypeId\": \"\",\n \"documentTypeName\": \"\",\n \"paymentTermsId\": \"\",\n \"paymentTermsName\": \"\",\n \"basePriceListId\": \"\",\n \"basePriceListName\": \"\",\n \"discountPriceListId\": \"\",\n \"discountPriceListName\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"withholdingTaxTypeName\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"totalQuantity\": \"\",\n \"grossAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"discountAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"specialDiscountPct\": \"\",\n \"specialDiscountAmount\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"earlyPaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatAmount\": \"\",\n \"surchargeEquivalencePct\": \"\",\n \"surchargeEquivalenceAmount\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"withholdingTaxAmount\": \"\",\n \"shippingAmount\": \"\",\n \"financingPct\": \"\",\n \"financingAmount\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"commercialTotalAmount\": \"\",\n \"total\": \"\",\n \"totalPaid\": \"\",\n \"outstandingAmount\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"currencyDecimals\": \"\",\n \"currencyDecimalsSystem\": \"\",\n \"exchangeRate\": \"\",\n \"grossAmountSystem\": \"\",\n \"discountAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"roundingMode\": \"\",\n \"relationConcept\": \"\",\n \"relationType\": \"\",\n \"linkableQuantity\": \"\",\n \"relationQuantity\": \"\",\n \"totalApprovals\": \"\",\n \"validatedApprovals\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"DELIVERY_NOTE\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"INVENTORY_TRANSFER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"C\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"MC\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"grossAmount\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatPct\": \"\",\n \"vatAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"surchargePct\": \"\",\n \"surchargeAmount\": \"\",\n \"total\": \"\",\n \"commercialTotalAmount\": \"\",\n \"discounts\": [\n {\n \"type\": \"INSURER\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n },\n {\n \"type\": \"POINTS\",\n \"id\": \"\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n }\n ],\n \"appliedPriceRule\": {\n \"id\": \"\",\n \"ruleType\": \"COMBO\",\n \"tariffId\": \"\",\n \"tariffName\": \"\",\n \"comboId\": \"\",\n \"comboName\": \"\",\n \"purchaseCondition\": \"\",\n \"purchaseConditionId\": \"\",\n \"discountConditionId\": \"\",\n \"discountValue\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ]\n },\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"grossAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"reservedQuantity\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"OPTICAL_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"opticalOrderId\": \"\",\n \"receivedQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"grossAmount\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatPct\": \"\",\n \"vatAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"surchargePct\": \"\",\n \"surchargeAmount\": \"\",\n \"total\": \"\",\n \"commercialTotalAmount\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"id\": \"\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n },\n {\n \"type\": \"DISCOUNT\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n }\n ],\n \"appliedPriceRule\": {\n \"id\": \"\",\n \"ruleType\": \"COMBO\",\n \"tariffId\": \"\",\n \"tariffName\": \"\",\n \"comboId\": \"\",\n \"comboName\": \"\",\n \"purchaseCondition\": \"\",\n \"purchaseConditionId\": \"\",\n \"discountConditionId\": \"\",\n \"discountValue\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ]\n },\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"grossAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"reservedQuantity\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"OPTICAL_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"INVOICE\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"opticalOrderId\": \"\",\n \"receivedQuantity\": \"\"\n }\n ],\n \"trackingCode\": \"\",\n \"subscription\": \"\",\n \"subscriptionOrderId\": \"\",\n \"manufacturingDate\": \"\",\n \"expiryDate\": \"\",\n \"finishedUnits\": \"\",\n \"soldOrder\": \"\",\n \"fabricationStatus\": \"\",\n \"lastFabricationStatusChange\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e170aa82-3458-4454-bb6e-b85c7fa71b72", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8d3a34a2-827c-4443-920c-e901ff9c3a17", "name": "Authenticated user is missing the `VER_PEDIDOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e50c3f4b-35d7-4d02-a236-dd194eb37a18", "name": "Purchase order not found", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ea6793e5-c5ff-49d3-914f-cf179aef15db", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ca2c72c0-9fc8-4f08-8046-e53822720fd8", "name": "Update purchase order", "request": { "name": "Update purchase order", "description": { "content": "Full replacement of an existing purchase order. Send the `If-Match` header with the current ETag for optimistic concurrency control. The `issued` flag is forced to `false` server-side.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "purchase-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Purchase order ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXEMPT\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"PIN\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"trackingCode\": \"\",\n \"subscription\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "504e9097-82ff-4d3b-8021-e12a00a5fee1", "name": "Purchase order updated", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXEMPT\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"PIN\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"trackingCode\": \"\",\n \"subscription\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"documentType\": \"DELIVERY_NOTE\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"deliveryStatus\": \"EP\",\n \"lifecycleStatus\": \"\",\n \"paymentStatus\": \"PAID\",\n \"documentStatusId\": \"\",\n \"documentStatusName\": \"\",\n \"issued\": \"\",\n \"draft\": \"\",\n \"enabled\": \"\",\n \"verified\": \"\",\n \"documentDate\": \"\",\n \"shippingDate\": \"\",\n \"counterpartyName\": \"\",\n \"counterpartyTaxId\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"companyTaxId\": \"\",\n \"warehouseName\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"optometristId\": \"\",\n \"optometristName\": \"\",\n \"documentTypeId\": \"\",\n \"documentTypeName\": \"\",\n \"paymentTermsId\": \"\",\n \"paymentTermsName\": \"\",\n \"basePriceListId\": \"\",\n \"basePriceListName\": \"\",\n \"discountPriceListId\": \"\",\n \"discountPriceListName\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"withholdingTaxTypeName\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"totalQuantity\": \"\",\n \"grossAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"discountAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"specialDiscountPct\": \"\",\n \"specialDiscountAmount\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"earlyPaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatAmount\": \"\",\n \"surchargeEquivalencePct\": \"\",\n \"surchargeEquivalenceAmount\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"withholdingTaxAmount\": \"\",\n \"shippingAmount\": \"\",\n \"financingPct\": \"\",\n \"financingAmount\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"commercialTotalAmount\": \"\",\n \"total\": \"\",\n \"totalPaid\": \"\",\n \"outstandingAmount\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"currencyDecimals\": \"\",\n \"currencyDecimalsSystem\": \"\",\n \"exchangeRate\": \"\",\n \"grossAmountSystem\": \"\",\n \"discountAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"roundingMode\": \"\",\n \"relationConcept\": \"\",\n \"relationType\": \"\",\n \"linkableQuantity\": \"\",\n \"relationQuantity\": \"\",\n \"totalApprovals\": \"\",\n \"validatedApprovals\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"DELIVERY_NOTE\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"INVENTORY_TRANSFER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"C\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"MC\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"grossAmount\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatPct\": \"\",\n \"vatAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"surchargePct\": \"\",\n \"surchargeAmount\": \"\",\n \"total\": \"\",\n \"commercialTotalAmount\": \"\",\n \"discounts\": [\n {\n \"type\": \"INSURER\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n },\n {\n \"type\": \"POINTS\",\n \"id\": \"\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n }\n ],\n \"appliedPriceRule\": {\n \"id\": \"\",\n \"ruleType\": \"COMBO\",\n \"tariffId\": \"\",\n \"tariffName\": \"\",\n \"comboId\": \"\",\n \"comboName\": \"\",\n \"purchaseCondition\": \"\",\n \"purchaseConditionId\": \"\",\n \"discountConditionId\": \"\",\n \"discountValue\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ]\n },\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"grossAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"reservedQuantity\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"OPTICAL_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"opticalOrderId\": \"\",\n \"receivedQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"grossAmount\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatPct\": \"\",\n \"vatAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"surchargePct\": \"\",\n \"surchargeAmount\": \"\",\n \"total\": \"\",\n \"commercialTotalAmount\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"id\": \"\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n },\n {\n \"type\": \"DISCOUNT\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n }\n ],\n \"appliedPriceRule\": {\n \"id\": \"\",\n \"ruleType\": \"COMBO\",\n \"tariffId\": \"\",\n \"tariffName\": \"\",\n \"comboId\": \"\",\n \"comboName\": \"\",\n \"purchaseCondition\": \"\",\n \"purchaseConditionId\": \"\",\n \"discountConditionId\": \"\",\n \"discountValue\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ]\n },\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"grossAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"reservedQuantity\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"OPTICAL_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"INVOICE\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"opticalOrderId\": \"\",\n \"receivedQuantity\": \"\"\n }\n ],\n \"trackingCode\": \"\",\n \"subscription\": \"\",\n \"subscriptionOrderId\": \"\",\n \"manufacturingDate\": \"\",\n \"expiryDate\": \"\",\n \"finishedUnits\": \"\",\n \"soldOrder\": \"\",\n \"fabricationStatus\": \"\",\n \"lastFabricationStatusChange\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d7a079f1-4fea-4410-8268-aede0e53ac04", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXEMPT\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"PIN\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"trackingCode\": \"\",\n \"subscription\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "10af98aa-401f-4ce8-b744-d71e46ed11f5", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXEMPT\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"PIN\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"trackingCode\": \"\",\n \"subscription\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8eb29050-cabf-4f87-aad9-c004a5714e71", "name": "Authenticated user is missing the `EDITAR_PEDIDOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXEMPT\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"PIN\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"trackingCode\": \"\",\n \"subscription\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "097a12e5-8782-49d3-81da-e2ccb434bb55", "name": "Purchase order not found", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXEMPT\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"PIN\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"trackingCode\": \"\",\n \"subscription\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "99036373-1462-4680-92d2-0ed71297244a", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXEMPT\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"PIN\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"trackingCode\": \"\",\n \"subscription\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "21fcc624-de82-4c82-9a60-9d1011a22343", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXEMPT\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"PIN\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"trackingCode\": \"\",\n \"subscription\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ab77b666-c14d-46d0-bb3e-8515e2250e0e", "name": "Delete purchase order", "request": { "name": "Delete purchase order", "description": { "content": "Deletes a purchase order. Send the `If-Match` header with the current ETag for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "purchase-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Purchase order ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "2e11e978-85df-448b-9006-8ab8bd43cb80", "name": "Purchase order deleted", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0578fac1-639f-445c-bcac-1192e49a00ad", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "56f71bdc-93b9-43b9-9440-a5c3d467f7c9", "name": "Authenticated user is missing the `BORRAR_PEDIDOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9bb1efab-d510-4c95-a71f-75938b386850", "name": "Purchase order not found", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4d015432-dfd6-46c9-9788-12564ca0abbf", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6e90ee8e-8a88-445d-9669-5e6a423a3d6d", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9063d734-0c2f-453a-8566-f1ee978f20c5", "name": "Merge-patch purchase order", "request": { "name": "Merge-patch purchase order", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "purchase-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Purchase order ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "50bd8e60-6131-40d5-8a75-6fd1a19d0fb7", "name": "Purchase order patched", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"documentType\": \"DELIVERY_NOTE\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"deliveryStatus\": \"EP\",\n \"lifecycleStatus\": \"\",\n \"paymentStatus\": \"PAID\",\n \"documentStatusId\": \"\",\n \"documentStatusName\": \"\",\n \"issued\": \"\",\n \"draft\": \"\",\n \"enabled\": \"\",\n \"verified\": \"\",\n \"documentDate\": \"\",\n \"shippingDate\": \"\",\n \"counterpartyName\": \"\",\n \"counterpartyTaxId\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"companyTaxId\": \"\",\n \"warehouseName\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"optometristId\": \"\",\n \"optometristName\": \"\",\n \"documentTypeId\": \"\",\n \"documentTypeName\": \"\",\n \"paymentTermsId\": \"\",\n \"paymentTermsName\": \"\",\n \"basePriceListId\": \"\",\n \"basePriceListName\": \"\",\n \"discountPriceListId\": \"\",\n \"discountPriceListName\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"withholdingTaxTypeName\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"totalQuantity\": \"\",\n \"grossAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"discountAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"specialDiscountPct\": \"\",\n \"specialDiscountAmount\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"earlyPaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatAmount\": \"\",\n \"surchargeEquivalencePct\": \"\",\n \"surchargeEquivalenceAmount\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"withholdingTaxAmount\": \"\",\n \"shippingAmount\": \"\",\n \"financingPct\": \"\",\n \"financingAmount\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"commercialTotalAmount\": \"\",\n \"total\": \"\",\n \"totalPaid\": \"\",\n \"outstandingAmount\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"currencyDecimals\": \"\",\n \"currencyDecimalsSystem\": \"\",\n \"exchangeRate\": \"\",\n \"grossAmountSystem\": \"\",\n \"discountAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"roundingMode\": \"\",\n \"relationConcept\": \"\",\n \"relationType\": \"\",\n \"linkableQuantity\": \"\",\n \"relationQuantity\": \"\",\n \"totalApprovals\": \"\",\n \"validatedApprovals\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"DELIVERY_NOTE\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"INVENTORY_TRANSFER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"C\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"MC\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"grossAmount\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatPct\": \"\",\n \"vatAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"surchargePct\": \"\",\n \"surchargeAmount\": \"\",\n \"total\": \"\",\n \"commercialTotalAmount\": \"\",\n \"discounts\": [\n {\n \"type\": \"INSURER\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n },\n {\n \"type\": \"POINTS\",\n \"id\": \"\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n }\n ],\n \"appliedPriceRule\": {\n \"id\": \"\",\n \"ruleType\": \"COMBO\",\n \"tariffId\": \"\",\n \"tariffName\": \"\",\n \"comboId\": \"\",\n \"comboName\": \"\",\n \"purchaseCondition\": \"\",\n \"purchaseConditionId\": \"\",\n \"discountConditionId\": \"\",\n \"discountValue\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ]\n },\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"grossAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"reservedQuantity\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"OPTICAL_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"opticalOrderId\": \"\",\n \"receivedQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"grossAmount\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatPct\": \"\",\n \"vatAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"surchargePct\": \"\",\n \"surchargeAmount\": \"\",\n \"total\": \"\",\n \"commercialTotalAmount\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"id\": \"\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n },\n {\n \"type\": \"DISCOUNT\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n }\n ],\n \"appliedPriceRule\": {\n \"id\": \"\",\n \"ruleType\": \"COMBO\",\n \"tariffId\": \"\",\n \"tariffName\": \"\",\n \"comboId\": \"\",\n \"comboName\": \"\",\n \"purchaseCondition\": \"\",\n \"purchaseConditionId\": \"\",\n \"discountConditionId\": \"\",\n \"discountValue\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ]\n },\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"grossAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"reservedQuantity\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"OPTICAL_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"INVOICE\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"opticalOrderId\": \"\",\n \"receivedQuantity\": \"\"\n }\n ],\n \"trackingCode\": \"\",\n \"subscription\": \"\",\n \"subscriptionOrderId\": \"\",\n \"manufacturingDate\": \"\",\n \"expiryDate\": \"\",\n \"finishedUnits\": \"\",\n \"soldOrder\": \"\",\n \"fabricationStatus\": \"\",\n \"lastFabricationStatusChange\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3c98effb-e171-4532-a681-302e9dc9c258", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details. Also returned for malformed merge-patch payloads.", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ccf7576e-6c8a-4175-a33f-1570a1bebd6c", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "299aca02-89dd-4366-a961-766cd3f63d68", "name": "Authenticated user is missing the `EDITAR_PEDIDOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a29c666e-3e21-4d18-8d23-053db61e5322", "name": "Purchase order not found", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "763f3519-485c-4b0d-b4a3-dfe5c67e2abf", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "857e434f-1a20-468e-99f5-addc1c38b95e", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "c4dfb816-cff0-43c6-96e1-a6378f8335de", "name": "List purchase orders", "request": { "name": "List purchase orders", "description": { "content": "Returns a paginated list of supplier purchase orders with envelope `{data, totalCount, skip, limit, hasMore}`. Supports optional RSQL `filter`, `sort` (default `lastModifiedAt:desc`), `skip`/`limit` pagination and `modifiedAfter`/`modifiedBefore` bookends. Limit is capped at 200; skip is clamped to >= 0. The constraint `issued==false` is always enforced server-side.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "purchase-orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "83e4f527-a16d-48c8-bcfe-58ee90914a78", "name": "Page of purchase orders", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "af7cde42-4fd9-4fde-a5f7-5095dd45eeb0", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ab366e24-c6ae-4ffd-860d-beb5d6bd17fb", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "11a69649-093e-406e-a55c-96ddf0c40877", "name": "Authenticated user is missing the `VER_PEDIDOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d7b7c2e2-0c63-401b-bf4f-35ed68943a19", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8056bda7-d90e-4e80-a14e-a2d365388d82", "name": "Create purchase order", "request": { "name": "Create purchase order", "description": { "content": "Creates a new supplier purchase order with the provided data and optional line items and payments. The `issued` flag is forced to `false` server-side regardless of the request payload.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "purchase-orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXEMPT\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"PIN\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"trackingCode\": \"\",\n \"subscription\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "5cfd3f6b-1b1a-411b-920f-5385b6030b17", "name": "Purchase order created", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXEMPT\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"PIN\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"trackingCode\": \"\",\n \"subscription\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"documentType\": \"DELIVERY_NOTE\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"deliveryStatus\": \"EP\",\n \"lifecycleStatus\": \"\",\n \"paymentStatus\": \"PAID\",\n \"documentStatusId\": \"\",\n \"documentStatusName\": \"\",\n \"issued\": \"\",\n \"draft\": \"\",\n \"enabled\": \"\",\n \"verified\": \"\",\n \"documentDate\": \"\",\n \"shippingDate\": \"\",\n \"counterpartyName\": \"\",\n \"counterpartyTaxId\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"companyTaxId\": \"\",\n \"warehouseName\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"optometristId\": \"\",\n \"optometristName\": \"\",\n \"documentTypeId\": \"\",\n \"documentTypeName\": \"\",\n \"paymentTermsId\": \"\",\n \"paymentTermsName\": \"\",\n \"basePriceListId\": \"\",\n \"basePriceListName\": \"\",\n \"discountPriceListId\": \"\",\n \"discountPriceListName\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"withholdingTaxTypeName\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"totalQuantity\": \"\",\n \"grossAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"discountAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"specialDiscountPct\": \"\",\n \"specialDiscountAmount\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"earlyPaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatAmount\": \"\",\n \"surchargeEquivalencePct\": \"\",\n \"surchargeEquivalenceAmount\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"withholdingTaxAmount\": \"\",\n \"shippingAmount\": \"\",\n \"financingPct\": \"\",\n \"financingAmount\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"commercialTotalAmount\": \"\",\n \"total\": \"\",\n \"totalPaid\": \"\",\n \"outstandingAmount\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"currencyDecimals\": \"\",\n \"currencyDecimalsSystem\": \"\",\n \"exchangeRate\": \"\",\n \"grossAmountSystem\": \"\",\n \"discountAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"roundingMode\": \"\",\n \"relationConcept\": \"\",\n \"relationType\": \"\",\n \"linkableQuantity\": \"\",\n \"relationQuantity\": \"\",\n \"totalApprovals\": \"\",\n \"validatedApprovals\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"DELIVERY_NOTE\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"INVENTORY_TRANSFER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"C\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"MC\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"grossAmount\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatPct\": \"\",\n \"vatAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"surchargePct\": \"\",\n \"surchargeAmount\": \"\",\n \"total\": \"\",\n \"commercialTotalAmount\": \"\",\n \"discounts\": [\n {\n \"type\": \"INSURER\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n },\n {\n \"type\": \"POINTS\",\n \"id\": \"\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n }\n ],\n \"appliedPriceRule\": {\n \"id\": \"\",\n \"ruleType\": \"COMBO\",\n \"tariffId\": \"\",\n \"tariffName\": \"\",\n \"comboId\": \"\",\n \"comboName\": \"\",\n \"purchaseCondition\": \"\",\n \"purchaseConditionId\": \"\",\n \"discountConditionId\": \"\",\n \"discountValue\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ]\n },\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"grossAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"reservedQuantity\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"OPTICAL_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"opticalOrderId\": \"\",\n \"receivedQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"grossAmount\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatPct\": \"\",\n \"vatAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"surchargePct\": \"\",\n \"surchargeAmount\": \"\",\n \"total\": \"\",\n \"commercialTotalAmount\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"id\": \"\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n },\n {\n \"type\": \"DISCOUNT\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n }\n ],\n \"appliedPriceRule\": {\n \"id\": \"\",\n \"ruleType\": \"COMBO\",\n \"tariffId\": \"\",\n \"tariffName\": \"\",\n \"comboId\": \"\",\n \"comboName\": \"\",\n \"purchaseCondition\": \"\",\n \"purchaseConditionId\": \"\",\n \"discountConditionId\": \"\",\n \"discountValue\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ]\n },\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"grossAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"reservedQuantity\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"OPTICAL_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"INVOICE\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"opticalOrderId\": \"\",\n \"receivedQuantity\": \"\"\n }\n ],\n \"trackingCode\": \"\",\n \"subscription\": \"\",\n \"subscriptionOrderId\": \"\",\n \"manufacturingDate\": \"\",\n \"expiryDate\": \"\",\n \"finishedUnits\": \"\",\n \"soldOrder\": \"\",\n \"fabricationStatus\": \"\",\n \"lastFabricationStatusChange\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5e6f11ab-eca7-4025-8d5d-f8faf370b5c6", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXEMPT\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"PIN\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"trackingCode\": \"\",\n \"subscription\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a8eb1c25-771c-4166-8604-fdcf8c29b5aa", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXEMPT\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"PIN\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"trackingCode\": \"\",\n \"subscription\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "edb7267f-fef9-4f21-9811-8004439228e3", "name": "Authenticated user is missing the `CREAR_PEDIDOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXEMPT\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"PIN\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"trackingCode\": \"\",\n \"subscription\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "930646ff-3e8e-4a79-a846-cbf4ef662689", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXEMPT\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"PIN\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"DELIVERY_NOTE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"trackingCode\": \"\",\n \"subscription\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "purchase-invoices", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "fb25817c-e364-4de3-9ede-3df963b9854e", "name": "Get purchase invoice by ID", "request": { "name": "Get purchase invoice by ID", "description": { "content": "Returns a single purchase invoice by its primary key. Returns 404 when the requested ID belongs to a sales (issued) document.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "purchase-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Purchase invoice ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "d49330b0-bc10-48be-8faa-09e65f87d783", "name": "Purchase invoice found", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase invoice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"counterpartyId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"grossAmount\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatPct\": \"\",\n \"vatAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"surchargePct\": \"\",\n \"surchargeAmount\": \"\",\n \"total\": \"\",\n \"commercialTotalAmount\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n }\n ],\n \"appliedPriceRule\": {\n \"id\": \"\",\n \"ruleType\": \"COMBO\",\n \"tariffId\": \"\",\n \"tariffName\": \"\",\n \"comboId\": \"\",\n \"comboName\": \"\",\n \"purchaseCondition\": \"\",\n \"purchaseConditionId\": \"\",\n \"discountConditionId\": \"\",\n \"discountValue\": \"\",\n \"categoryIds\": [\n \"\"\n ]\n },\n \"excludedTariffIds\": [\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"grossAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"reservedQuantity\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"PURCHASE_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"opticalOrderId\": \"\",\n \"deliveryStatus\": \"\",\n \"sunatUnitOfMeasure\": \"NIU\"\n }\n ],\n \"warehouseId\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"documentType\": \"INVOICE\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"deliveryStatus\": \"EP\",\n \"lifecycleStatus\": \"\",\n \"paymentStatus\": \"UNPAID\",\n \"documentStatusId\": \"\",\n \"documentStatusName\": \"\",\n \"issued\": \"\",\n \"draft\": \"\",\n \"enabled\": \"\",\n \"verified\": \"\",\n \"documentDate\": \"\",\n \"shippingDate\": \"\",\n \"counterpartyName\": \"\",\n \"counterpartyTaxId\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"companyTaxId\": \"\",\n \"warehouseName\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"optometristId\": \"\",\n \"optometristName\": \"\",\n \"documentTypeId\": \"\",\n \"documentTypeName\": \"\",\n \"paymentTermsId\": \"\",\n \"paymentTermsName\": \"\",\n \"basePriceListId\": \"\",\n \"basePriceListName\": \"\",\n \"discountPriceListId\": \"\",\n \"discountPriceListName\": \"\",\n \"taxBehavior\": \"EXEMPT\",\n \"withholdingTaxTypeId\": \"\",\n \"withholdingTaxTypeName\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"totalQuantity\": \"\",\n \"grossAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"discountAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"specialDiscountPct\": \"\",\n \"specialDiscountAmount\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"earlyPaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatAmount\": \"\",\n \"surchargeEquivalencePct\": \"\",\n \"surchargeEquivalenceAmount\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"withholdingTaxAmount\": \"\",\n \"shippingAmount\": \"\",\n \"financingPct\": \"\",\n \"financingAmount\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"commercialTotalAmount\": \"\",\n \"total\": \"\",\n \"totalPaid\": \"\",\n \"outstandingAmount\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"currencyDecimals\": \"\",\n \"currencyDecimalsSystem\": \"\",\n \"exchangeRate\": \"\",\n \"grossAmountSystem\": \"\",\n \"discountAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"roundingMode\": \"\",\n \"relationConcept\": \"\",\n \"relationType\": \"\",\n \"linkableQuantity\": \"\",\n \"relationQuantity\": \"\",\n \"totalApprovals\": \"\",\n \"validatedApprovals\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"QUOTE\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"RI\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"pricesIncludeTax\": \"\",\n \"generateDeliveryNote\": \"\",\n \"issueDate\": \"\",\n \"accountingDate\": \"\",\n \"receptionDate\": \"\",\n \"counterpartyType\": \"CC\",\n \"totalWithholdings\": \"\",\n \"accountingNumber\": \"\",\n \"journalEntryId\": \"\",\n \"accountingLedger\": \"\",\n \"linkedToAccounting\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"withholdingTaxAccountId\": \"\",\n \"withholdingTaxAccountName\": \"\",\n \"activityId\": \"\",\n \"activityName\": \"\",\n \"invoiceType\": \"SUB\",\n \"simplified\": \"\",\n \"creditNoteType\": \"\",\n \"saleCondition\": \"\",\n \"reverseCharge\": \"\",\n \"intraCommunity\": \"\",\n \"insuranceInvoice\": \"\",\n \"visitReasonId\": \"\",\n \"visitReasonName\": \"\",\n \"primaryInsurerId\": \"\",\n \"primaryInsurerName\": \"\",\n \"secondaryInsurerId\": \"\",\n \"secondaryInsurerName\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"tertiaryInsurerName\": \"\",\n \"primaryContractNumber\": \"\",\n \"secondaryContractNumber\": \"\",\n \"tertiaryContractNumber\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insuredPartyId\": \"\",\n \"insuredPartyName\": \"\",\n \"insuredNationalId\": \"\",\n \"insuredPolicyNumber\": \"\",\n \"insuredClaimNumber\": \"\",\n \"pointsWalletId\": \"\",\n \"pointsWalletToRedeemId\": \"\",\n \"customerPointsBalance\": \"\",\n \"pointsEarned\": \"\",\n \"pointsRedeemed\": \"\",\n \"pointsValueAmount\": \"\",\n \"opticalDataId\": \"\",\n \"discountPinId\": \"\",\n \"claimId\": \"\",\n \"installments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"dueDate\": \"\",\n \"paid\": \"\",\n \"issued\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"paymentId\": \"\",\n \"withholdingLineId\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"withholdingTaxPct\": \"\"\n }\n ],\n \"totalInstallments\": \"\",\n \"paidInstallments\": \"\",\n \"electronicInvoice\": {\n \"id\": \"\",\n \"signStatus\": \"SUBMIT_ERROR\",\n \"signedAt\": \"\",\n \"lastSignErrorCode\": \"\",\n \"lastSignErrorMessage\": \"\",\n \"sunatHash\": \"\",\n \"sunatInvoiceCode\": \"\",\n \"sunatQrCode\": \"\",\n \"dgiCufe\": \"\",\n \"dgiAuthorizationNumber\": \"\",\n \"dgiSecNumber\": \"\",\n \"dgiDv\": \"\",\n \"dgiQrCode\": \"\",\n \"dgiSystemRef\": \"\"\n },\n \"verifactuStatus\": \"\",\n \"verifactuReady\": \"\",\n \"cfdiUsage\": \"\",\n \"satPaymentMethod\": \"\",\n \"cancellationRecordId\": \"\",\n \"folioNumber\": \"\",\n \"establishmentCode\": \"\",\n \"emissionPointCode\": \"\",\n \"authorizationCode\": \"\",\n \"global\": \"\",\n \"globalInvoiceId\": \"\",\n \"fiscalDocumentNumber\": \"\",\n \"fiscalPrinterSerial\": \"\",\n \"sunatPaymentMethod\": \"CO\",\n \"capabilities\": {\n \"header\": {\n \"allowed\": \"\",\n \"code\": \"VERIFACTU_STATE\",\n \"reason\": \"\"\n },\n \"counterparty\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"documentDate\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"internalFields\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"amounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"unitPrices\": {\n \"allowed\": \"\",\n \"code\": \"VERIFACTU_STATE\",\n \"reason\": \"\"\n },\n \"manualDiscounts\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"lineDescriptions\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"products\": {\n \"allowed\": \"\",\n \"code\": \"VERIFACTU_STATE\",\n \"reason\": \"\"\n },\n \"quantities\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"accounting\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"payments\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"insurerAmounts\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"costCenters\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"opticalOrders\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"edit\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"delete\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n }\n },\n \"einvoiceError\": \"\",\n \"einvoiceXmlUrl\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bae1f17e-4b37-4fa4-bbfa-230e47d06b33", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase invoice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1a8be6f3-df3f-45b3-8002-55400fd10533", "name": "Authenticated user is missing the `VER_FACTURASRECIBIDAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase invoice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "67a0ab7a-8997-4f7b-ba6e-640cf1fd7fb2", "name": "Purchase invoice not found", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase invoice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ea5ef356-3cfc-4936-ada5-f64006278c77", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase invoice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c7a97718-955b-45ec-b235-9b1ab01cf5d9", "name": "Update purchase invoice", "request": { "name": "Update purchase invoice", "description": { "content": "Full replacement of an existing purchase invoice. Send the `If-Match` header with the current ETag for optimistic concurrency control. The `issued` flag is forced to `false` server-side.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "purchase-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Purchase invoice ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"POINTS\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\",\n \"sunatUnitOfMeasure\": \"NIU\"\n }\n ],\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"pricesIncludeTax\": \"\",\n \"generateDeliveryNote\": \"\",\n \"issueDate\": \"\",\n \"accountingDate\": \"\",\n \"receptionDate\": \"\",\n \"counterpartyType\": \"MS\",\n \"accountingLedger\": \"\",\n \"linkedToAccounting\": \"\",\n \"counterpartyAccountId\": \"\",\n \"withholdingTaxAccountId\": \"\",\n \"activityId\": \"\",\n \"simplified\": \"\",\n \"saleCondition\": \"\",\n \"reverseCharge\": \"\",\n \"intraCommunity\": \"\",\n \"insuranceInvoice\": \"\",\n \"visitReasonId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryContractNumber\": \"\",\n \"secondaryContractNumber\": \"\",\n \"tertiaryContractNumber\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insuredPartyId\": \"\",\n \"insuredNationalId\": \"\",\n \"insuredPolicyNumber\": \"\",\n \"insuredClaimNumber\": \"\",\n \"pointsWalletToRedeemId\": \"\",\n \"pointsToRedeem\": \"\",\n \"discountPinId\": \"\",\n \"installments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n }\n ],\n \"electronicInvoice\": {\n \"signStatus\": \"RECEIVED_PENDING\",\n \"signedAt\": \"\",\n \"lastSignErrorCode\": \"\",\n \"lastSignErrorMessage\": \"\",\n \"sunatHash\": \"\",\n \"sunatInvoiceCode\": \"\",\n \"sunatQrCode\": \"\",\n \"dgiCufe\": \"\",\n \"dgiAuthorizationNumber\": \"\",\n \"dgiSecNumber\": \"\",\n \"dgiDv\": \"\",\n \"dgiQrCode\": \"\",\n \"dgiSystemRef\": \"\"\n },\n \"sunatPaymentMethod\": \"CR\",\n \"capabilities\": {\n \"header\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"counterparty\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"documentDate\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"internalFields\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"amounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"unitPrices\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"manualDiscounts\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"lineDescriptions\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"products\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"quantities\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"accounting\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"payments\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"insurerAmounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"costCenters\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"opticalOrders\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"edit\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"delete\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n }\n },\n \"einvoiceError\": \"\",\n \"einvoiceXmlUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "c088ed52-9d20-466d-930c-6d5c4088b6f0", "name": "Purchase invoice updated", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase invoice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"POINTS\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\",\n \"sunatUnitOfMeasure\": \"NIU\"\n }\n ],\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"pricesIncludeTax\": \"\",\n \"generateDeliveryNote\": \"\",\n \"issueDate\": \"\",\n \"accountingDate\": \"\",\n \"receptionDate\": \"\",\n \"counterpartyType\": \"MS\",\n \"accountingLedger\": \"\",\n \"linkedToAccounting\": \"\",\n \"counterpartyAccountId\": \"\",\n \"withholdingTaxAccountId\": \"\",\n \"activityId\": \"\",\n \"simplified\": \"\",\n \"saleCondition\": \"\",\n \"reverseCharge\": \"\",\n \"intraCommunity\": \"\",\n \"insuranceInvoice\": \"\",\n \"visitReasonId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryContractNumber\": \"\",\n \"secondaryContractNumber\": \"\",\n \"tertiaryContractNumber\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insuredPartyId\": \"\",\n \"insuredNationalId\": \"\",\n \"insuredPolicyNumber\": \"\",\n \"insuredClaimNumber\": \"\",\n \"pointsWalletToRedeemId\": \"\",\n \"pointsToRedeem\": \"\",\n \"discountPinId\": \"\",\n \"installments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n }\n ],\n \"electronicInvoice\": {\n \"signStatus\": \"RECEIVED_PENDING\",\n \"signedAt\": \"\",\n \"lastSignErrorCode\": \"\",\n \"lastSignErrorMessage\": \"\",\n \"sunatHash\": \"\",\n \"sunatInvoiceCode\": \"\",\n \"sunatQrCode\": \"\",\n \"dgiCufe\": \"\",\n \"dgiAuthorizationNumber\": \"\",\n \"dgiSecNumber\": \"\",\n \"dgiDv\": \"\",\n \"dgiQrCode\": \"\",\n \"dgiSystemRef\": \"\"\n },\n \"sunatPaymentMethod\": \"CR\",\n \"capabilities\": {\n \"header\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"counterparty\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"documentDate\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"internalFields\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"amounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"unitPrices\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"manualDiscounts\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"lineDescriptions\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"products\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"quantities\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"accounting\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"payments\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"insurerAmounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"costCenters\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"opticalOrders\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"edit\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"delete\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n }\n },\n \"einvoiceError\": \"\",\n \"einvoiceXmlUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"counterpartyId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"grossAmount\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatPct\": \"\",\n \"vatAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"surchargePct\": \"\",\n \"surchargeAmount\": \"\",\n \"total\": \"\",\n \"commercialTotalAmount\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n }\n ],\n \"appliedPriceRule\": {\n \"id\": \"\",\n \"ruleType\": \"COMBO\",\n \"tariffId\": \"\",\n \"tariffName\": \"\",\n \"comboId\": \"\",\n \"comboName\": \"\",\n \"purchaseCondition\": \"\",\n \"purchaseConditionId\": \"\",\n \"discountConditionId\": \"\",\n \"discountValue\": \"\",\n \"categoryIds\": [\n \"\"\n ]\n },\n \"excludedTariffIds\": [\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"grossAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"reservedQuantity\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"PURCHASE_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"opticalOrderId\": \"\",\n \"deliveryStatus\": \"\",\n \"sunatUnitOfMeasure\": \"NIU\"\n }\n ],\n \"warehouseId\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"documentType\": \"INVOICE\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"deliveryStatus\": \"EP\",\n \"lifecycleStatus\": \"\",\n \"paymentStatus\": \"UNPAID\",\n \"documentStatusId\": \"\",\n \"documentStatusName\": \"\",\n \"issued\": \"\",\n \"draft\": \"\",\n \"enabled\": \"\",\n \"verified\": \"\",\n \"documentDate\": \"\",\n \"shippingDate\": \"\",\n \"counterpartyName\": \"\",\n \"counterpartyTaxId\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"companyTaxId\": \"\",\n \"warehouseName\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"optometristId\": \"\",\n \"optometristName\": \"\",\n \"documentTypeId\": \"\",\n \"documentTypeName\": \"\",\n \"paymentTermsId\": \"\",\n \"paymentTermsName\": \"\",\n \"basePriceListId\": \"\",\n \"basePriceListName\": \"\",\n \"discountPriceListId\": \"\",\n \"discountPriceListName\": \"\",\n \"taxBehavior\": \"EXEMPT\",\n \"withholdingTaxTypeId\": \"\",\n \"withholdingTaxTypeName\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"totalQuantity\": \"\",\n \"grossAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"discountAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"specialDiscountPct\": \"\",\n \"specialDiscountAmount\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"earlyPaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatAmount\": \"\",\n \"surchargeEquivalencePct\": \"\",\n \"surchargeEquivalenceAmount\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"withholdingTaxAmount\": \"\",\n \"shippingAmount\": \"\",\n \"financingPct\": \"\",\n \"financingAmount\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"commercialTotalAmount\": \"\",\n \"total\": \"\",\n \"totalPaid\": \"\",\n \"outstandingAmount\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"currencyDecimals\": \"\",\n \"currencyDecimalsSystem\": \"\",\n \"exchangeRate\": \"\",\n \"grossAmountSystem\": \"\",\n \"discountAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"roundingMode\": \"\",\n \"relationConcept\": \"\",\n \"relationType\": \"\",\n \"linkableQuantity\": \"\",\n \"relationQuantity\": \"\",\n \"totalApprovals\": \"\",\n \"validatedApprovals\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"QUOTE\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"RI\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"pricesIncludeTax\": \"\",\n \"generateDeliveryNote\": \"\",\n \"issueDate\": \"\",\n \"accountingDate\": \"\",\n \"receptionDate\": \"\",\n \"counterpartyType\": \"CC\",\n \"totalWithholdings\": \"\",\n \"accountingNumber\": \"\",\n \"journalEntryId\": \"\",\n \"accountingLedger\": \"\",\n \"linkedToAccounting\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"withholdingTaxAccountId\": \"\",\n \"withholdingTaxAccountName\": \"\",\n \"activityId\": \"\",\n \"activityName\": \"\",\n \"invoiceType\": \"SUB\",\n \"simplified\": \"\",\n \"creditNoteType\": \"\",\n \"saleCondition\": \"\",\n \"reverseCharge\": \"\",\n \"intraCommunity\": \"\",\n \"insuranceInvoice\": \"\",\n \"visitReasonId\": \"\",\n \"visitReasonName\": \"\",\n \"primaryInsurerId\": \"\",\n \"primaryInsurerName\": \"\",\n \"secondaryInsurerId\": \"\",\n \"secondaryInsurerName\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"tertiaryInsurerName\": \"\",\n \"primaryContractNumber\": \"\",\n \"secondaryContractNumber\": \"\",\n \"tertiaryContractNumber\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insuredPartyId\": \"\",\n \"insuredPartyName\": \"\",\n \"insuredNationalId\": \"\",\n \"insuredPolicyNumber\": \"\",\n \"insuredClaimNumber\": \"\",\n \"pointsWalletId\": \"\",\n \"pointsWalletToRedeemId\": \"\",\n \"customerPointsBalance\": \"\",\n \"pointsEarned\": \"\",\n \"pointsRedeemed\": \"\",\n \"pointsValueAmount\": \"\",\n \"opticalDataId\": \"\",\n \"discountPinId\": \"\",\n \"claimId\": \"\",\n \"installments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"dueDate\": \"\",\n \"paid\": \"\",\n \"issued\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"paymentId\": \"\",\n \"withholdingLineId\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"withholdingTaxPct\": \"\"\n }\n ],\n \"totalInstallments\": \"\",\n \"paidInstallments\": \"\",\n \"electronicInvoice\": {\n \"id\": \"\",\n \"signStatus\": \"SUBMIT_ERROR\",\n \"signedAt\": \"\",\n \"lastSignErrorCode\": \"\",\n \"lastSignErrorMessage\": \"\",\n \"sunatHash\": \"\",\n \"sunatInvoiceCode\": \"\",\n \"sunatQrCode\": \"\",\n \"dgiCufe\": \"\",\n \"dgiAuthorizationNumber\": \"\",\n \"dgiSecNumber\": \"\",\n \"dgiDv\": \"\",\n \"dgiQrCode\": \"\",\n \"dgiSystemRef\": \"\"\n },\n \"verifactuStatus\": \"\",\n \"verifactuReady\": \"\",\n \"cfdiUsage\": \"\",\n \"satPaymentMethod\": \"\",\n \"cancellationRecordId\": \"\",\n \"folioNumber\": \"\",\n \"establishmentCode\": \"\",\n \"emissionPointCode\": \"\",\n \"authorizationCode\": \"\",\n \"global\": \"\",\n \"globalInvoiceId\": \"\",\n \"fiscalDocumentNumber\": \"\",\n \"fiscalPrinterSerial\": \"\",\n \"sunatPaymentMethod\": \"CO\",\n \"capabilities\": {\n \"header\": {\n \"allowed\": \"\",\n \"code\": \"VERIFACTU_STATE\",\n \"reason\": \"\"\n },\n \"counterparty\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"documentDate\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"internalFields\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"amounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"unitPrices\": {\n \"allowed\": \"\",\n \"code\": \"VERIFACTU_STATE\",\n \"reason\": \"\"\n },\n \"manualDiscounts\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"lineDescriptions\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"products\": {\n \"allowed\": \"\",\n \"code\": \"VERIFACTU_STATE\",\n \"reason\": \"\"\n },\n \"quantities\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"accounting\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"payments\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"insurerAmounts\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"costCenters\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"opticalOrders\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"edit\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"delete\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n }\n },\n \"einvoiceError\": \"\",\n \"einvoiceXmlUrl\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f5429885-da0d-46f1-808f-7fcf00af3714", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase invoice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"POINTS\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\",\n \"sunatUnitOfMeasure\": \"NIU\"\n }\n ],\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"pricesIncludeTax\": \"\",\n \"generateDeliveryNote\": \"\",\n \"issueDate\": \"\",\n \"accountingDate\": \"\",\n \"receptionDate\": \"\",\n \"counterpartyType\": \"MS\",\n \"accountingLedger\": \"\",\n \"linkedToAccounting\": \"\",\n \"counterpartyAccountId\": \"\",\n \"withholdingTaxAccountId\": \"\",\n \"activityId\": \"\",\n \"simplified\": \"\",\n \"saleCondition\": \"\",\n \"reverseCharge\": \"\",\n \"intraCommunity\": \"\",\n \"insuranceInvoice\": \"\",\n \"visitReasonId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryContractNumber\": \"\",\n \"secondaryContractNumber\": \"\",\n \"tertiaryContractNumber\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insuredPartyId\": \"\",\n \"insuredNationalId\": \"\",\n \"insuredPolicyNumber\": \"\",\n \"insuredClaimNumber\": \"\",\n \"pointsWalletToRedeemId\": \"\",\n \"pointsToRedeem\": \"\",\n \"discountPinId\": \"\",\n \"installments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n }\n ],\n \"electronicInvoice\": {\n \"signStatus\": \"RECEIVED_PENDING\",\n \"signedAt\": \"\",\n \"lastSignErrorCode\": \"\",\n \"lastSignErrorMessage\": \"\",\n \"sunatHash\": \"\",\n \"sunatInvoiceCode\": \"\",\n \"sunatQrCode\": \"\",\n \"dgiCufe\": \"\",\n \"dgiAuthorizationNumber\": \"\",\n \"dgiSecNumber\": \"\",\n \"dgiDv\": \"\",\n \"dgiQrCode\": \"\",\n \"dgiSystemRef\": \"\"\n },\n \"sunatPaymentMethod\": \"CR\",\n \"capabilities\": {\n \"header\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"counterparty\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"documentDate\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"internalFields\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"amounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"unitPrices\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"manualDiscounts\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"lineDescriptions\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"products\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"quantities\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"accounting\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"payments\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"insurerAmounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"costCenters\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"opticalOrders\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"edit\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"delete\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n }\n },\n \"einvoiceError\": \"\",\n \"einvoiceXmlUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ab6e98e3-b5a6-44eb-b10e-75b806d143f7", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase invoice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"POINTS\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\",\n \"sunatUnitOfMeasure\": \"NIU\"\n }\n ],\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"pricesIncludeTax\": \"\",\n \"generateDeliveryNote\": \"\",\n \"issueDate\": \"\",\n \"accountingDate\": \"\",\n \"receptionDate\": \"\",\n \"counterpartyType\": \"MS\",\n \"accountingLedger\": \"\",\n \"linkedToAccounting\": \"\",\n \"counterpartyAccountId\": \"\",\n \"withholdingTaxAccountId\": \"\",\n \"activityId\": \"\",\n \"simplified\": \"\",\n \"saleCondition\": \"\",\n \"reverseCharge\": \"\",\n \"intraCommunity\": \"\",\n \"insuranceInvoice\": \"\",\n \"visitReasonId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryContractNumber\": \"\",\n \"secondaryContractNumber\": \"\",\n \"tertiaryContractNumber\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insuredPartyId\": \"\",\n \"insuredNationalId\": \"\",\n \"insuredPolicyNumber\": \"\",\n \"insuredClaimNumber\": \"\",\n \"pointsWalletToRedeemId\": \"\",\n \"pointsToRedeem\": \"\",\n \"discountPinId\": \"\",\n \"installments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n }\n ],\n \"electronicInvoice\": {\n \"signStatus\": \"RECEIVED_PENDING\",\n \"signedAt\": \"\",\n \"lastSignErrorCode\": \"\",\n \"lastSignErrorMessage\": \"\",\n \"sunatHash\": \"\",\n \"sunatInvoiceCode\": \"\",\n \"sunatQrCode\": \"\",\n \"dgiCufe\": \"\",\n \"dgiAuthorizationNumber\": \"\",\n \"dgiSecNumber\": \"\",\n \"dgiDv\": \"\",\n \"dgiQrCode\": \"\",\n \"dgiSystemRef\": \"\"\n },\n \"sunatPaymentMethod\": \"CR\",\n \"capabilities\": {\n \"header\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"counterparty\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"documentDate\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"internalFields\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"amounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"unitPrices\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"manualDiscounts\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"lineDescriptions\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"products\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"quantities\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"accounting\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"payments\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"insurerAmounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"costCenters\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"opticalOrders\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"edit\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"delete\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n }\n },\n \"einvoiceError\": \"\",\n \"einvoiceXmlUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "70fc0c43-e7e7-4929-a0e9-ea2405124b58", "name": "Authenticated user is missing the `EDITAR_FACTURASRECIBIDAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase invoice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"POINTS\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\",\n \"sunatUnitOfMeasure\": \"NIU\"\n }\n ],\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"pricesIncludeTax\": \"\",\n \"generateDeliveryNote\": \"\",\n \"issueDate\": \"\",\n \"accountingDate\": \"\",\n \"receptionDate\": \"\",\n \"counterpartyType\": \"MS\",\n \"accountingLedger\": \"\",\n \"linkedToAccounting\": \"\",\n \"counterpartyAccountId\": \"\",\n \"withholdingTaxAccountId\": \"\",\n \"activityId\": \"\",\n \"simplified\": \"\",\n \"saleCondition\": \"\",\n \"reverseCharge\": \"\",\n \"intraCommunity\": \"\",\n \"insuranceInvoice\": \"\",\n \"visitReasonId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryContractNumber\": \"\",\n \"secondaryContractNumber\": \"\",\n \"tertiaryContractNumber\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insuredPartyId\": \"\",\n \"insuredNationalId\": \"\",\n \"insuredPolicyNumber\": \"\",\n \"insuredClaimNumber\": \"\",\n \"pointsWalletToRedeemId\": \"\",\n \"pointsToRedeem\": \"\",\n \"discountPinId\": \"\",\n \"installments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n }\n ],\n \"electronicInvoice\": {\n \"signStatus\": \"RECEIVED_PENDING\",\n \"signedAt\": \"\",\n \"lastSignErrorCode\": \"\",\n \"lastSignErrorMessage\": \"\",\n \"sunatHash\": \"\",\n \"sunatInvoiceCode\": \"\",\n \"sunatQrCode\": \"\",\n \"dgiCufe\": \"\",\n \"dgiAuthorizationNumber\": \"\",\n \"dgiSecNumber\": \"\",\n \"dgiDv\": \"\",\n \"dgiQrCode\": \"\",\n \"dgiSystemRef\": \"\"\n },\n \"sunatPaymentMethod\": \"CR\",\n \"capabilities\": {\n \"header\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"counterparty\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"documentDate\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"internalFields\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"amounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"unitPrices\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"manualDiscounts\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"lineDescriptions\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"products\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"quantities\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"accounting\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"payments\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"insurerAmounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"costCenters\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"opticalOrders\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"edit\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"delete\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n }\n },\n \"einvoiceError\": \"\",\n \"einvoiceXmlUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "765573fd-649a-42d9-920d-61ebfcf4c74b", "name": "Purchase invoice not found", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase invoice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"POINTS\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\",\n \"sunatUnitOfMeasure\": \"NIU\"\n }\n ],\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"pricesIncludeTax\": \"\",\n \"generateDeliveryNote\": \"\",\n \"issueDate\": \"\",\n \"accountingDate\": \"\",\n \"receptionDate\": \"\",\n \"counterpartyType\": \"MS\",\n \"accountingLedger\": \"\",\n \"linkedToAccounting\": \"\",\n \"counterpartyAccountId\": \"\",\n \"withholdingTaxAccountId\": \"\",\n \"activityId\": \"\",\n \"simplified\": \"\",\n \"saleCondition\": \"\",\n \"reverseCharge\": \"\",\n \"intraCommunity\": \"\",\n \"insuranceInvoice\": \"\",\n \"visitReasonId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryContractNumber\": \"\",\n \"secondaryContractNumber\": \"\",\n \"tertiaryContractNumber\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insuredPartyId\": \"\",\n \"insuredNationalId\": \"\",\n \"insuredPolicyNumber\": \"\",\n \"insuredClaimNumber\": \"\",\n \"pointsWalletToRedeemId\": \"\",\n \"pointsToRedeem\": \"\",\n \"discountPinId\": \"\",\n \"installments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n }\n ],\n \"electronicInvoice\": {\n \"signStatus\": \"RECEIVED_PENDING\",\n \"signedAt\": \"\",\n \"lastSignErrorCode\": \"\",\n \"lastSignErrorMessage\": \"\",\n \"sunatHash\": \"\",\n \"sunatInvoiceCode\": \"\",\n \"sunatQrCode\": \"\",\n \"dgiCufe\": \"\",\n \"dgiAuthorizationNumber\": \"\",\n \"dgiSecNumber\": \"\",\n \"dgiDv\": \"\",\n \"dgiQrCode\": \"\",\n \"dgiSystemRef\": \"\"\n },\n \"sunatPaymentMethod\": \"CR\",\n \"capabilities\": {\n \"header\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"counterparty\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"documentDate\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"internalFields\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"amounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"unitPrices\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"manualDiscounts\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"lineDescriptions\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"products\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"quantities\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"accounting\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"payments\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"insurerAmounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"costCenters\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"opticalOrders\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"edit\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"delete\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n }\n },\n \"einvoiceError\": \"\",\n \"einvoiceXmlUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0c7bf450-c054-47fe-8bb7-d976f58c111e", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase invoice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"POINTS\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\",\n \"sunatUnitOfMeasure\": \"NIU\"\n }\n ],\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"pricesIncludeTax\": \"\",\n \"generateDeliveryNote\": \"\",\n \"issueDate\": \"\",\n \"accountingDate\": \"\",\n \"receptionDate\": \"\",\n \"counterpartyType\": \"MS\",\n \"accountingLedger\": \"\",\n \"linkedToAccounting\": \"\",\n \"counterpartyAccountId\": \"\",\n \"withholdingTaxAccountId\": \"\",\n \"activityId\": \"\",\n \"simplified\": \"\",\n \"saleCondition\": \"\",\n \"reverseCharge\": \"\",\n \"intraCommunity\": \"\",\n \"insuranceInvoice\": \"\",\n \"visitReasonId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryContractNumber\": \"\",\n \"secondaryContractNumber\": \"\",\n \"tertiaryContractNumber\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insuredPartyId\": \"\",\n \"insuredNationalId\": \"\",\n \"insuredPolicyNumber\": \"\",\n \"insuredClaimNumber\": \"\",\n \"pointsWalletToRedeemId\": \"\",\n \"pointsToRedeem\": \"\",\n \"discountPinId\": \"\",\n \"installments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n }\n ],\n \"electronicInvoice\": {\n \"signStatus\": \"RECEIVED_PENDING\",\n \"signedAt\": \"\",\n \"lastSignErrorCode\": \"\",\n \"lastSignErrorMessage\": \"\",\n \"sunatHash\": \"\",\n \"sunatInvoiceCode\": \"\",\n \"sunatQrCode\": \"\",\n \"dgiCufe\": \"\",\n \"dgiAuthorizationNumber\": \"\",\n \"dgiSecNumber\": \"\",\n \"dgiDv\": \"\",\n \"dgiQrCode\": \"\",\n \"dgiSystemRef\": \"\"\n },\n \"sunatPaymentMethod\": \"CR\",\n \"capabilities\": {\n \"header\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"counterparty\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"documentDate\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"internalFields\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"amounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"unitPrices\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"manualDiscounts\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"lineDescriptions\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"products\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"quantities\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"accounting\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"payments\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"insurerAmounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"costCenters\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"opticalOrders\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"edit\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"delete\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n }\n },\n \"einvoiceError\": \"\",\n \"einvoiceXmlUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0a350fb8-82fc-4842-b07a-fa9310039411", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase invoice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"POINTS\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\",\n \"sunatUnitOfMeasure\": \"NIU\"\n }\n ],\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"pricesIncludeTax\": \"\",\n \"generateDeliveryNote\": \"\",\n \"issueDate\": \"\",\n \"accountingDate\": \"\",\n \"receptionDate\": \"\",\n \"counterpartyType\": \"MS\",\n \"accountingLedger\": \"\",\n \"linkedToAccounting\": \"\",\n \"counterpartyAccountId\": \"\",\n \"withholdingTaxAccountId\": \"\",\n \"activityId\": \"\",\n \"simplified\": \"\",\n \"saleCondition\": \"\",\n \"reverseCharge\": \"\",\n \"intraCommunity\": \"\",\n \"insuranceInvoice\": \"\",\n \"visitReasonId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryContractNumber\": \"\",\n \"secondaryContractNumber\": \"\",\n \"tertiaryContractNumber\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insuredPartyId\": \"\",\n \"insuredNationalId\": \"\",\n \"insuredPolicyNumber\": \"\",\n \"insuredClaimNumber\": \"\",\n \"pointsWalletToRedeemId\": \"\",\n \"pointsToRedeem\": \"\",\n \"discountPinId\": \"\",\n \"installments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n }\n ],\n \"electronicInvoice\": {\n \"signStatus\": \"RECEIVED_PENDING\",\n \"signedAt\": \"\",\n \"lastSignErrorCode\": \"\",\n \"lastSignErrorMessage\": \"\",\n \"sunatHash\": \"\",\n \"sunatInvoiceCode\": \"\",\n \"sunatQrCode\": \"\",\n \"dgiCufe\": \"\",\n \"dgiAuthorizationNumber\": \"\",\n \"dgiSecNumber\": \"\",\n \"dgiDv\": \"\",\n \"dgiQrCode\": \"\",\n \"dgiSystemRef\": \"\"\n },\n \"sunatPaymentMethod\": \"CR\",\n \"capabilities\": {\n \"header\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"counterparty\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"documentDate\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"internalFields\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"amounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"unitPrices\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"manualDiscounts\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"lineDescriptions\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"products\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"quantities\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"accounting\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"payments\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"insurerAmounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"costCenters\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"opticalOrders\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"edit\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"delete\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n }\n },\n \"einvoiceError\": \"\",\n \"einvoiceXmlUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cd20ac82-18b7-4606-81a7-a17278b23a42", "name": "Delete purchase invoice", "request": { "name": "Delete purchase invoice", "description": { "content": "Deletes a purchase invoice. Send the `If-Match` header with the current ETag for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "purchase-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Purchase invoice ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "e56fcd50-0663-4ed9-96e9-87357f00959a", "name": "Purchase invoice deleted", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase invoice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2af4346f-c2f5-4594-b212-74f9788ebd9d", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase invoice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "17514704-e1ed-4bd7-9256-efa7601c6561", "name": "Authenticated user is missing the `BORRAR_FACTURASRECIBIDAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase invoice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4ad25eac-c8b7-462a-8d4f-74d4218f45b1", "name": "Purchase invoice not found", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase invoice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "abb1634d-c6ca-41bc-a5ae-2b994c67f5f1", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase invoice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4feeca8c-4c15-45d6-9018-a7c7acac9811", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase invoice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4d586e0c-9df0-4b6e-89a7-9003d2c9abaf", "name": "Merge-patch purchase invoice", "request": { "name": "Merge-patch purchase invoice", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "purchase-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Purchase invoice ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "9a96ee9d-9a59-413e-a244-47cccb262b6a", "name": "Purchase invoice patched", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase invoice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"counterpartyId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"grossAmount\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatPct\": \"\",\n \"vatAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"surchargePct\": \"\",\n \"surchargeAmount\": \"\",\n \"total\": \"\",\n \"commercialTotalAmount\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n }\n ],\n \"appliedPriceRule\": {\n \"id\": \"\",\n \"ruleType\": \"COMBO\",\n \"tariffId\": \"\",\n \"tariffName\": \"\",\n \"comboId\": \"\",\n \"comboName\": \"\",\n \"purchaseCondition\": \"\",\n \"purchaseConditionId\": \"\",\n \"discountConditionId\": \"\",\n \"discountValue\": \"\",\n \"categoryIds\": [\n \"\"\n ]\n },\n \"excludedTariffIds\": [\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"grossAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"reservedQuantity\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"PURCHASE_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"opticalOrderId\": \"\",\n \"deliveryStatus\": \"\",\n \"sunatUnitOfMeasure\": \"NIU\"\n }\n ],\n \"warehouseId\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"documentType\": \"INVOICE\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"deliveryStatus\": \"EP\",\n \"lifecycleStatus\": \"\",\n \"paymentStatus\": \"UNPAID\",\n \"documentStatusId\": \"\",\n \"documentStatusName\": \"\",\n \"issued\": \"\",\n \"draft\": \"\",\n \"enabled\": \"\",\n \"verified\": \"\",\n \"documentDate\": \"\",\n \"shippingDate\": \"\",\n \"counterpartyName\": \"\",\n \"counterpartyTaxId\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"companyTaxId\": \"\",\n \"warehouseName\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"optometristId\": \"\",\n \"optometristName\": \"\",\n \"documentTypeId\": \"\",\n \"documentTypeName\": \"\",\n \"paymentTermsId\": \"\",\n \"paymentTermsName\": \"\",\n \"basePriceListId\": \"\",\n \"basePriceListName\": \"\",\n \"discountPriceListId\": \"\",\n \"discountPriceListName\": \"\",\n \"taxBehavior\": \"EXEMPT\",\n \"withholdingTaxTypeId\": \"\",\n \"withholdingTaxTypeName\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"totalQuantity\": \"\",\n \"grossAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"discountAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"specialDiscountPct\": \"\",\n \"specialDiscountAmount\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"earlyPaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatAmount\": \"\",\n \"surchargeEquivalencePct\": \"\",\n \"surchargeEquivalenceAmount\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"withholdingTaxAmount\": \"\",\n \"shippingAmount\": \"\",\n \"financingPct\": \"\",\n \"financingAmount\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"commercialTotalAmount\": \"\",\n \"total\": \"\",\n \"totalPaid\": \"\",\n \"outstandingAmount\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"currencyDecimals\": \"\",\n \"currencyDecimalsSystem\": \"\",\n \"exchangeRate\": \"\",\n \"grossAmountSystem\": \"\",\n \"discountAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"roundingMode\": \"\",\n \"relationConcept\": \"\",\n \"relationType\": \"\",\n \"linkableQuantity\": \"\",\n \"relationQuantity\": \"\",\n \"totalApprovals\": \"\",\n \"validatedApprovals\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"QUOTE\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"RI\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"pricesIncludeTax\": \"\",\n \"generateDeliveryNote\": \"\",\n \"issueDate\": \"\",\n \"accountingDate\": \"\",\n \"receptionDate\": \"\",\n \"counterpartyType\": \"CC\",\n \"totalWithholdings\": \"\",\n \"accountingNumber\": \"\",\n \"journalEntryId\": \"\",\n \"accountingLedger\": \"\",\n \"linkedToAccounting\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"withholdingTaxAccountId\": \"\",\n \"withholdingTaxAccountName\": \"\",\n \"activityId\": \"\",\n \"activityName\": \"\",\n \"invoiceType\": \"SUB\",\n \"simplified\": \"\",\n \"creditNoteType\": \"\",\n \"saleCondition\": \"\",\n \"reverseCharge\": \"\",\n \"intraCommunity\": \"\",\n \"insuranceInvoice\": \"\",\n \"visitReasonId\": \"\",\n \"visitReasonName\": \"\",\n \"primaryInsurerId\": \"\",\n \"primaryInsurerName\": \"\",\n \"secondaryInsurerId\": \"\",\n \"secondaryInsurerName\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"tertiaryInsurerName\": \"\",\n \"primaryContractNumber\": \"\",\n \"secondaryContractNumber\": \"\",\n \"tertiaryContractNumber\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insuredPartyId\": \"\",\n \"insuredPartyName\": \"\",\n \"insuredNationalId\": \"\",\n \"insuredPolicyNumber\": \"\",\n \"insuredClaimNumber\": \"\",\n \"pointsWalletId\": \"\",\n \"pointsWalletToRedeemId\": \"\",\n \"customerPointsBalance\": \"\",\n \"pointsEarned\": \"\",\n \"pointsRedeemed\": \"\",\n \"pointsValueAmount\": \"\",\n \"opticalDataId\": \"\",\n \"discountPinId\": \"\",\n \"claimId\": \"\",\n \"installments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"dueDate\": \"\",\n \"paid\": \"\",\n \"issued\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"paymentId\": \"\",\n \"withholdingLineId\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"withholdingTaxPct\": \"\"\n }\n ],\n \"totalInstallments\": \"\",\n \"paidInstallments\": \"\",\n \"electronicInvoice\": {\n \"id\": \"\",\n \"signStatus\": \"SUBMIT_ERROR\",\n \"signedAt\": \"\",\n \"lastSignErrorCode\": \"\",\n \"lastSignErrorMessage\": \"\",\n \"sunatHash\": \"\",\n \"sunatInvoiceCode\": \"\",\n \"sunatQrCode\": \"\",\n \"dgiCufe\": \"\",\n \"dgiAuthorizationNumber\": \"\",\n \"dgiSecNumber\": \"\",\n \"dgiDv\": \"\",\n \"dgiQrCode\": \"\",\n \"dgiSystemRef\": \"\"\n },\n \"verifactuStatus\": \"\",\n \"verifactuReady\": \"\",\n \"cfdiUsage\": \"\",\n \"satPaymentMethod\": \"\",\n \"cancellationRecordId\": \"\",\n \"folioNumber\": \"\",\n \"establishmentCode\": \"\",\n \"emissionPointCode\": \"\",\n \"authorizationCode\": \"\",\n \"global\": \"\",\n \"globalInvoiceId\": \"\",\n \"fiscalDocumentNumber\": \"\",\n \"fiscalPrinterSerial\": \"\",\n \"sunatPaymentMethod\": \"CO\",\n \"capabilities\": {\n \"header\": {\n \"allowed\": \"\",\n \"code\": \"VERIFACTU_STATE\",\n \"reason\": \"\"\n },\n \"counterparty\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"documentDate\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"internalFields\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"amounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"unitPrices\": {\n \"allowed\": \"\",\n \"code\": \"VERIFACTU_STATE\",\n \"reason\": \"\"\n },\n \"manualDiscounts\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"lineDescriptions\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"products\": {\n \"allowed\": \"\",\n \"code\": \"VERIFACTU_STATE\",\n \"reason\": \"\"\n },\n \"quantities\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"accounting\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"payments\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"insurerAmounts\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"costCenters\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"opticalOrders\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"edit\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"delete\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n }\n },\n \"einvoiceError\": \"\",\n \"einvoiceXmlUrl\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9ef996c5-b61e-42e9-a279-d4a726b8c8b8", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details. Also returned for malformed merge-patch payloads.", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase invoice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "79971aa4-f771-4a13-aca6-763878c27f5c", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase invoice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4cc7d6b3-b298-493a-b6e2-0c38408247e9", "name": "Authenticated user is missing the `EDITAR_FACTURASRECIBIDAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase invoice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9fbca4d2-9d5d-4663-b938-91d58fced888", "name": "Purchase invoice not found", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase invoice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "27b44146-babe-45c4-bcbd-76516e9d477e", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase invoice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "88ecc732-edd6-4ada-b2e0-3212ccfb0890", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase invoice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "07b77d95-5daf-4acf-8e13-f8e32fa0a8aa", "name": "List purchase invoices", "request": { "name": "List purchase invoices", "description": { "content": "Returns a paginated list of supplier purchase invoices with envelope `{data, totalCount, skip, limit, hasMore}`. Supports optional RSQL `filter`, `sort` (default `lastModifiedAt:desc`), `skip`/`limit` pagination and `modifiedAfter`/`modifiedBefore` bookends. Limit is capped at 200; skip is clamped to >= 0. The constraint `issued==false` is always enforced server-side.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "purchase-invoices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "0c930b2f-14e4-4db2-9da1-1b29567c5601", "name": "Page of purchase invoices", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-invoices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ff95b717-e6e6-428e-92b0-dd1e38ccdd71", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-invoices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c4f2bc88-4fc6-442b-99bc-0925d3be8f91", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-invoices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5f3fb057-24fd-449b-b8d0-71b4686de855", "name": "Authenticated user is missing the `VER_FACTURASRECIBIDAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-invoices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "60ceb1be-71b4-47b7-b719-a96a5bad3879", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-invoices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d8aedd4f-83cf-47ef-adbf-b5f46a9c8236", "name": "Create purchase invoice", "request": { "name": "Create purchase invoice", "description": { "content": "Creates a new supplier purchase invoice with the provided data and optional line items and payments. The `issued` flag is forced to `false` server-side regardless of the request payload.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "purchase-invoices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"POINTS\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\",\n \"sunatUnitOfMeasure\": \"NIU\"\n }\n ],\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"pricesIncludeTax\": \"\",\n \"generateDeliveryNote\": \"\",\n \"issueDate\": \"\",\n \"accountingDate\": \"\",\n \"receptionDate\": \"\",\n \"counterpartyType\": \"MS\",\n \"accountingLedger\": \"\",\n \"linkedToAccounting\": \"\",\n \"counterpartyAccountId\": \"\",\n \"withholdingTaxAccountId\": \"\",\n \"activityId\": \"\",\n \"simplified\": \"\",\n \"saleCondition\": \"\",\n \"reverseCharge\": \"\",\n \"intraCommunity\": \"\",\n \"insuranceInvoice\": \"\",\n \"visitReasonId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryContractNumber\": \"\",\n \"secondaryContractNumber\": \"\",\n \"tertiaryContractNumber\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insuredPartyId\": \"\",\n \"insuredNationalId\": \"\",\n \"insuredPolicyNumber\": \"\",\n \"insuredClaimNumber\": \"\",\n \"pointsWalletToRedeemId\": \"\",\n \"pointsToRedeem\": \"\",\n \"discountPinId\": \"\",\n \"installments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n }\n ],\n \"electronicInvoice\": {\n \"signStatus\": \"RECEIVED_PENDING\",\n \"signedAt\": \"\",\n \"lastSignErrorCode\": \"\",\n \"lastSignErrorMessage\": \"\",\n \"sunatHash\": \"\",\n \"sunatInvoiceCode\": \"\",\n \"sunatQrCode\": \"\",\n \"dgiCufe\": \"\",\n \"dgiAuthorizationNumber\": \"\",\n \"dgiSecNumber\": \"\",\n \"dgiDv\": \"\",\n \"dgiQrCode\": \"\",\n \"dgiSystemRef\": \"\"\n },\n \"sunatPaymentMethod\": \"CR\",\n \"capabilities\": {\n \"header\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"counterparty\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"documentDate\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"internalFields\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"amounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"unitPrices\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"manualDiscounts\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"lineDescriptions\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"products\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"quantities\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"accounting\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"payments\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"insurerAmounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"costCenters\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"opticalOrders\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"edit\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"delete\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n }\n },\n \"einvoiceError\": \"\",\n \"einvoiceXmlUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "9c259188-9872-43d4-ba23-4d98a4983210", "name": "Purchase invoice created", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-invoices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"POINTS\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\",\n \"sunatUnitOfMeasure\": \"NIU\"\n }\n ],\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"pricesIncludeTax\": \"\",\n \"generateDeliveryNote\": \"\",\n \"issueDate\": \"\",\n \"accountingDate\": \"\",\n \"receptionDate\": \"\",\n \"counterpartyType\": \"MS\",\n \"accountingLedger\": \"\",\n \"linkedToAccounting\": \"\",\n \"counterpartyAccountId\": \"\",\n \"withholdingTaxAccountId\": \"\",\n \"activityId\": \"\",\n \"simplified\": \"\",\n \"saleCondition\": \"\",\n \"reverseCharge\": \"\",\n \"intraCommunity\": \"\",\n \"insuranceInvoice\": \"\",\n \"visitReasonId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryContractNumber\": \"\",\n \"secondaryContractNumber\": \"\",\n \"tertiaryContractNumber\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insuredPartyId\": \"\",\n \"insuredNationalId\": \"\",\n \"insuredPolicyNumber\": \"\",\n \"insuredClaimNumber\": \"\",\n \"pointsWalletToRedeemId\": \"\",\n \"pointsToRedeem\": \"\",\n \"discountPinId\": \"\",\n \"installments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n }\n ],\n \"electronicInvoice\": {\n \"signStatus\": \"RECEIVED_PENDING\",\n \"signedAt\": \"\",\n \"lastSignErrorCode\": \"\",\n \"lastSignErrorMessage\": \"\",\n \"sunatHash\": \"\",\n \"sunatInvoiceCode\": \"\",\n \"sunatQrCode\": \"\",\n \"dgiCufe\": \"\",\n \"dgiAuthorizationNumber\": \"\",\n \"dgiSecNumber\": \"\",\n \"dgiDv\": \"\",\n \"dgiQrCode\": \"\",\n \"dgiSystemRef\": \"\"\n },\n \"sunatPaymentMethod\": \"CR\",\n \"capabilities\": {\n \"header\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"counterparty\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"documentDate\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"internalFields\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"amounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"unitPrices\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"manualDiscounts\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"lineDescriptions\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"products\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"quantities\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"accounting\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"payments\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"insurerAmounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"costCenters\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"opticalOrders\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"edit\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"delete\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n }\n },\n \"einvoiceError\": \"\",\n \"einvoiceXmlUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"counterpartyId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"grossAmount\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatPct\": \"\",\n \"vatAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"surchargePct\": \"\",\n \"surchargeAmount\": \"\",\n \"total\": \"\",\n \"commercialTotalAmount\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n }\n ],\n \"appliedPriceRule\": {\n \"id\": \"\",\n \"ruleType\": \"COMBO\",\n \"tariffId\": \"\",\n \"tariffName\": \"\",\n \"comboId\": \"\",\n \"comboName\": \"\",\n \"purchaseCondition\": \"\",\n \"purchaseConditionId\": \"\",\n \"discountConditionId\": \"\",\n \"discountValue\": \"\",\n \"categoryIds\": [\n \"\"\n ]\n },\n \"excludedTariffIds\": [\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"grossAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"reservedQuantity\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"PURCHASE_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"opticalOrderId\": \"\",\n \"deliveryStatus\": \"\",\n \"sunatUnitOfMeasure\": \"NIU\"\n }\n ],\n \"warehouseId\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"documentType\": \"INVOICE\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"deliveryStatus\": \"EP\",\n \"lifecycleStatus\": \"\",\n \"paymentStatus\": \"UNPAID\",\n \"documentStatusId\": \"\",\n \"documentStatusName\": \"\",\n \"issued\": \"\",\n \"draft\": \"\",\n \"enabled\": \"\",\n \"verified\": \"\",\n \"documentDate\": \"\",\n \"shippingDate\": \"\",\n \"counterpartyName\": \"\",\n \"counterpartyTaxId\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"companyTaxId\": \"\",\n \"warehouseName\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"optometristId\": \"\",\n \"optometristName\": \"\",\n \"documentTypeId\": \"\",\n \"documentTypeName\": \"\",\n \"paymentTermsId\": \"\",\n \"paymentTermsName\": \"\",\n \"basePriceListId\": \"\",\n \"basePriceListName\": \"\",\n \"discountPriceListId\": \"\",\n \"discountPriceListName\": \"\",\n \"taxBehavior\": \"EXEMPT\",\n \"withholdingTaxTypeId\": \"\",\n \"withholdingTaxTypeName\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"totalQuantity\": \"\",\n \"grossAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"discountAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"specialDiscountPct\": \"\",\n \"specialDiscountAmount\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"earlyPaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatAmount\": \"\",\n \"surchargeEquivalencePct\": \"\",\n \"surchargeEquivalenceAmount\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"withholdingTaxAmount\": \"\",\n \"shippingAmount\": \"\",\n \"financingPct\": \"\",\n \"financingAmount\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"commercialTotalAmount\": \"\",\n \"total\": \"\",\n \"totalPaid\": \"\",\n \"outstandingAmount\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"currencyDecimals\": \"\",\n \"currencyDecimalsSystem\": \"\",\n \"exchangeRate\": \"\",\n \"grossAmountSystem\": \"\",\n \"discountAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"roundingMode\": \"\",\n \"relationConcept\": \"\",\n \"relationType\": \"\",\n \"linkableQuantity\": \"\",\n \"relationQuantity\": \"\",\n \"totalApprovals\": \"\",\n \"validatedApprovals\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"QUOTE\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"RI\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"pricesIncludeTax\": \"\",\n \"generateDeliveryNote\": \"\",\n \"issueDate\": \"\",\n \"accountingDate\": \"\",\n \"receptionDate\": \"\",\n \"counterpartyType\": \"CC\",\n \"totalWithholdings\": \"\",\n \"accountingNumber\": \"\",\n \"journalEntryId\": \"\",\n \"accountingLedger\": \"\",\n \"linkedToAccounting\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"withholdingTaxAccountId\": \"\",\n \"withholdingTaxAccountName\": \"\",\n \"activityId\": \"\",\n \"activityName\": \"\",\n \"invoiceType\": \"SUB\",\n \"simplified\": \"\",\n \"creditNoteType\": \"\",\n \"saleCondition\": \"\",\n \"reverseCharge\": \"\",\n \"intraCommunity\": \"\",\n \"insuranceInvoice\": \"\",\n \"visitReasonId\": \"\",\n \"visitReasonName\": \"\",\n \"primaryInsurerId\": \"\",\n \"primaryInsurerName\": \"\",\n \"secondaryInsurerId\": \"\",\n \"secondaryInsurerName\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"tertiaryInsurerName\": \"\",\n \"primaryContractNumber\": \"\",\n \"secondaryContractNumber\": \"\",\n \"tertiaryContractNumber\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insuredPartyId\": \"\",\n \"insuredPartyName\": \"\",\n \"insuredNationalId\": \"\",\n \"insuredPolicyNumber\": \"\",\n \"insuredClaimNumber\": \"\",\n \"pointsWalletId\": \"\",\n \"pointsWalletToRedeemId\": \"\",\n \"customerPointsBalance\": \"\",\n \"pointsEarned\": \"\",\n \"pointsRedeemed\": \"\",\n \"pointsValueAmount\": \"\",\n \"opticalDataId\": \"\",\n \"discountPinId\": \"\",\n \"claimId\": \"\",\n \"installments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"dueDate\": \"\",\n \"paid\": \"\",\n \"issued\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"paymentId\": \"\",\n \"withholdingLineId\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"withholdingTaxPct\": \"\"\n }\n ],\n \"totalInstallments\": \"\",\n \"paidInstallments\": \"\",\n \"electronicInvoice\": {\n \"id\": \"\",\n \"signStatus\": \"SUBMIT_ERROR\",\n \"signedAt\": \"\",\n \"lastSignErrorCode\": \"\",\n \"lastSignErrorMessage\": \"\",\n \"sunatHash\": \"\",\n \"sunatInvoiceCode\": \"\",\n \"sunatQrCode\": \"\",\n \"dgiCufe\": \"\",\n \"dgiAuthorizationNumber\": \"\",\n \"dgiSecNumber\": \"\",\n \"dgiDv\": \"\",\n \"dgiQrCode\": \"\",\n \"dgiSystemRef\": \"\"\n },\n \"verifactuStatus\": \"\",\n \"verifactuReady\": \"\",\n \"cfdiUsage\": \"\",\n \"satPaymentMethod\": \"\",\n \"cancellationRecordId\": \"\",\n \"folioNumber\": \"\",\n \"establishmentCode\": \"\",\n \"emissionPointCode\": \"\",\n \"authorizationCode\": \"\",\n \"global\": \"\",\n \"globalInvoiceId\": \"\",\n \"fiscalDocumentNumber\": \"\",\n \"fiscalPrinterSerial\": \"\",\n \"sunatPaymentMethod\": \"CO\",\n \"capabilities\": {\n \"header\": {\n \"allowed\": \"\",\n \"code\": \"VERIFACTU_STATE\",\n \"reason\": \"\"\n },\n \"counterparty\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"documentDate\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"internalFields\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"amounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"unitPrices\": {\n \"allowed\": \"\",\n \"code\": \"VERIFACTU_STATE\",\n \"reason\": \"\"\n },\n \"manualDiscounts\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"lineDescriptions\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"products\": {\n \"allowed\": \"\",\n \"code\": \"VERIFACTU_STATE\",\n \"reason\": \"\"\n },\n \"quantities\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"accounting\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"payments\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"insurerAmounts\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"costCenters\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"opticalOrders\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"edit\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"delete\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n }\n },\n \"einvoiceError\": \"\",\n \"einvoiceXmlUrl\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "17134c74-e0da-4a03-9108-090392f0b964", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-invoices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"POINTS\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\",\n \"sunatUnitOfMeasure\": \"NIU\"\n }\n ],\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"pricesIncludeTax\": \"\",\n \"generateDeliveryNote\": \"\",\n \"issueDate\": \"\",\n \"accountingDate\": \"\",\n \"receptionDate\": \"\",\n \"counterpartyType\": \"MS\",\n \"accountingLedger\": \"\",\n \"linkedToAccounting\": \"\",\n \"counterpartyAccountId\": \"\",\n \"withholdingTaxAccountId\": \"\",\n \"activityId\": \"\",\n \"simplified\": \"\",\n \"saleCondition\": \"\",\n \"reverseCharge\": \"\",\n \"intraCommunity\": \"\",\n \"insuranceInvoice\": \"\",\n \"visitReasonId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryContractNumber\": \"\",\n \"secondaryContractNumber\": \"\",\n \"tertiaryContractNumber\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insuredPartyId\": \"\",\n \"insuredNationalId\": \"\",\n \"insuredPolicyNumber\": \"\",\n \"insuredClaimNumber\": \"\",\n \"pointsWalletToRedeemId\": \"\",\n \"pointsToRedeem\": \"\",\n \"discountPinId\": \"\",\n \"installments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n }\n ],\n \"electronicInvoice\": {\n \"signStatus\": \"RECEIVED_PENDING\",\n \"signedAt\": \"\",\n \"lastSignErrorCode\": \"\",\n \"lastSignErrorMessage\": \"\",\n \"sunatHash\": \"\",\n \"sunatInvoiceCode\": \"\",\n \"sunatQrCode\": \"\",\n \"dgiCufe\": \"\",\n \"dgiAuthorizationNumber\": \"\",\n \"dgiSecNumber\": \"\",\n \"dgiDv\": \"\",\n \"dgiQrCode\": \"\",\n \"dgiSystemRef\": \"\"\n },\n \"sunatPaymentMethod\": \"CR\",\n \"capabilities\": {\n \"header\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"counterparty\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"documentDate\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"internalFields\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"amounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"unitPrices\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"manualDiscounts\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"lineDescriptions\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"products\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"quantities\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"accounting\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"payments\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"insurerAmounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"costCenters\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"opticalOrders\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"edit\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"delete\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n }\n },\n \"einvoiceError\": \"\",\n \"einvoiceXmlUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4676a162-35b1-4cf7-83f2-43b4cf6a086d", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-invoices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"POINTS\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\",\n \"sunatUnitOfMeasure\": \"NIU\"\n }\n ],\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"pricesIncludeTax\": \"\",\n \"generateDeliveryNote\": \"\",\n \"issueDate\": \"\",\n \"accountingDate\": \"\",\n \"receptionDate\": \"\",\n \"counterpartyType\": \"MS\",\n \"accountingLedger\": \"\",\n \"linkedToAccounting\": \"\",\n \"counterpartyAccountId\": \"\",\n \"withholdingTaxAccountId\": \"\",\n \"activityId\": \"\",\n \"simplified\": \"\",\n \"saleCondition\": \"\",\n \"reverseCharge\": \"\",\n \"intraCommunity\": \"\",\n \"insuranceInvoice\": \"\",\n \"visitReasonId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryContractNumber\": \"\",\n \"secondaryContractNumber\": \"\",\n \"tertiaryContractNumber\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insuredPartyId\": \"\",\n \"insuredNationalId\": \"\",\n \"insuredPolicyNumber\": \"\",\n \"insuredClaimNumber\": \"\",\n \"pointsWalletToRedeemId\": \"\",\n \"pointsToRedeem\": \"\",\n \"discountPinId\": \"\",\n \"installments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n }\n ],\n \"electronicInvoice\": {\n \"signStatus\": \"RECEIVED_PENDING\",\n \"signedAt\": \"\",\n \"lastSignErrorCode\": \"\",\n \"lastSignErrorMessage\": \"\",\n \"sunatHash\": \"\",\n \"sunatInvoiceCode\": \"\",\n \"sunatQrCode\": \"\",\n \"dgiCufe\": \"\",\n \"dgiAuthorizationNumber\": \"\",\n \"dgiSecNumber\": \"\",\n \"dgiDv\": \"\",\n \"dgiQrCode\": \"\",\n \"dgiSystemRef\": \"\"\n },\n \"sunatPaymentMethod\": \"CR\",\n \"capabilities\": {\n \"header\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"counterparty\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"documentDate\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"internalFields\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"amounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"unitPrices\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"manualDiscounts\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"lineDescriptions\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"products\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"quantities\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"accounting\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"payments\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"insurerAmounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"costCenters\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"opticalOrders\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"edit\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"delete\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n }\n },\n \"einvoiceError\": \"\",\n \"einvoiceXmlUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b37342f1-6f91-4e00-8150-79ff6e5fe990", "name": "Authenticated user is missing the `CREAR_FACTURASRECIBIDAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-invoices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"POINTS\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\",\n \"sunatUnitOfMeasure\": \"NIU\"\n }\n ],\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"pricesIncludeTax\": \"\",\n \"generateDeliveryNote\": \"\",\n \"issueDate\": \"\",\n \"accountingDate\": \"\",\n \"receptionDate\": \"\",\n \"counterpartyType\": \"MS\",\n \"accountingLedger\": \"\",\n \"linkedToAccounting\": \"\",\n \"counterpartyAccountId\": \"\",\n \"withholdingTaxAccountId\": \"\",\n \"activityId\": \"\",\n \"simplified\": \"\",\n \"saleCondition\": \"\",\n \"reverseCharge\": \"\",\n \"intraCommunity\": \"\",\n \"insuranceInvoice\": \"\",\n \"visitReasonId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryContractNumber\": \"\",\n \"secondaryContractNumber\": \"\",\n \"tertiaryContractNumber\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insuredPartyId\": \"\",\n \"insuredNationalId\": \"\",\n \"insuredPolicyNumber\": \"\",\n \"insuredClaimNumber\": \"\",\n \"pointsWalletToRedeemId\": \"\",\n \"pointsToRedeem\": \"\",\n \"discountPinId\": \"\",\n \"installments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n }\n ],\n \"electronicInvoice\": {\n \"signStatus\": \"RECEIVED_PENDING\",\n \"signedAt\": \"\",\n \"lastSignErrorCode\": \"\",\n \"lastSignErrorMessage\": \"\",\n \"sunatHash\": \"\",\n \"sunatInvoiceCode\": \"\",\n \"sunatQrCode\": \"\",\n \"dgiCufe\": \"\",\n \"dgiAuthorizationNumber\": \"\",\n \"dgiSecNumber\": \"\",\n \"dgiDv\": \"\",\n \"dgiQrCode\": \"\",\n \"dgiSystemRef\": \"\"\n },\n \"sunatPaymentMethod\": \"CR\",\n \"capabilities\": {\n \"header\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"counterparty\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"documentDate\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"internalFields\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"amounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"unitPrices\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"manualDiscounts\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"lineDescriptions\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"products\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"quantities\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"accounting\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"payments\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"insurerAmounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"costCenters\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"opticalOrders\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"edit\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"delete\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n }\n },\n \"einvoiceError\": \"\",\n \"einvoiceXmlUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3815976e-dcee-43b8-894b-9b21f51afe33", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-invoices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"PIN\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"POINTS\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\",\n \"sunatUnitOfMeasure\": \"NIU\"\n }\n ],\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"EXCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"pricesIncludeTax\": \"\",\n \"generateDeliveryNote\": \"\",\n \"issueDate\": \"\",\n \"accountingDate\": \"\",\n \"receptionDate\": \"\",\n \"counterpartyType\": \"MS\",\n \"accountingLedger\": \"\",\n \"linkedToAccounting\": \"\",\n \"counterpartyAccountId\": \"\",\n \"withholdingTaxAccountId\": \"\",\n \"activityId\": \"\",\n \"simplified\": \"\",\n \"saleCondition\": \"\",\n \"reverseCharge\": \"\",\n \"intraCommunity\": \"\",\n \"insuranceInvoice\": \"\",\n \"visitReasonId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryContractNumber\": \"\",\n \"secondaryContractNumber\": \"\",\n \"tertiaryContractNumber\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insuredPartyId\": \"\",\n \"insuredNationalId\": \"\",\n \"insuredPolicyNumber\": \"\",\n \"insuredClaimNumber\": \"\",\n \"pointsWalletToRedeemId\": \"\",\n \"pointsToRedeem\": \"\",\n \"discountPinId\": \"\",\n \"installments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"dueDate\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\"\n }\n ],\n \"electronicInvoice\": {\n \"signStatus\": \"RECEIVED_PENDING\",\n \"signedAt\": \"\",\n \"lastSignErrorCode\": \"\",\n \"lastSignErrorMessage\": \"\",\n \"sunatHash\": \"\",\n \"sunatInvoiceCode\": \"\",\n \"sunatQrCode\": \"\",\n \"dgiCufe\": \"\",\n \"dgiAuthorizationNumber\": \"\",\n \"dgiSecNumber\": \"\",\n \"dgiDv\": \"\",\n \"dgiQrCode\": \"\",\n \"dgiSystemRef\": \"\"\n },\n \"sunatPaymentMethod\": \"CR\",\n \"capabilities\": {\n \"header\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"counterparty\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"documentDate\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"internalFields\": {\n \"allowed\": \"\",\n \"code\": \"FISCAL_PRINTER_VE\",\n \"reason\": \"\"\n },\n \"amounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"unitPrices\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"manualDiscounts\": {\n \"allowed\": \"\",\n \"code\": \"MISSING_PERMISSION\",\n \"reason\": \"\"\n },\n \"lineDescriptions\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"products\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"quantities\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"accounting\": {\n \"allowed\": \"\",\n \"code\": \"CREDIT_NOTE_TYPE\",\n \"reason\": \"\"\n },\n \"payments\": {\n \"allowed\": \"\",\n \"code\": \"LOCK_TYPE\",\n \"reason\": \"\"\n },\n \"insurerAmounts\": {\n \"allowed\": \"\",\n \"code\": \"OLA_MODE\",\n \"reason\": \"\"\n },\n \"costCenters\": {\n \"allowed\": \"\",\n \"code\": \"AGENT_LOCK\",\n \"reason\": \"\"\n },\n \"opticalOrders\": {\n \"allowed\": \"\",\n \"code\": \"ORDER_CONTROL\",\n \"reason\": \"\"\n },\n \"edit\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n },\n \"delete\": {\n \"allowed\": \"\",\n \"code\": \"OLA_CREDIT_NOTE\",\n \"reason\": \"\"\n }\n },\n \"einvoiceError\": \"\",\n \"einvoiceXmlUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "purchase-delivery-notes", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "ada06230-a976-4147-a9cc-28b0d8adccb0", "name": "Get purchase delivery note by ID", "request": { "name": "Get purchase delivery note by ID", "description": { "content": "Returns a single purchase delivery note by its primary key, including line items and payments. Returns 404 when the requested ID belongs to a sales (issued) document.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "purchase-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Purchase delivery note ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "3f48880b-941b-486f-9636-503496ea0c0f", "name": "Purchase delivery note found", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase delivery note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"documentType\": \"INVOICE\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"deliveryStatus\": \"EP\",\n \"lifecycleStatus\": \"\",\n \"paymentStatus\": \"OVERPAID\",\n \"documentStatusId\": \"\",\n \"documentStatusName\": \"\",\n \"issued\": \"\",\n \"draft\": \"\",\n \"enabled\": \"\",\n \"verified\": \"\",\n \"documentDate\": \"\",\n \"shippingDate\": \"\",\n \"counterpartyName\": \"\",\n \"counterpartyTaxId\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"companyTaxId\": \"\",\n \"warehouseName\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"optometristId\": \"\",\n \"optometristName\": \"\",\n \"documentTypeId\": \"\",\n \"documentTypeName\": \"\",\n \"paymentTermsId\": \"\",\n \"paymentTermsName\": \"\",\n \"basePriceListId\": \"\",\n \"basePriceListName\": \"\",\n \"discountPriceListId\": \"\",\n \"discountPriceListName\": \"\",\n \"taxBehavior\": \"INCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"withholdingTaxTypeName\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"totalQuantity\": \"\",\n \"grossAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"discountAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"specialDiscountPct\": \"\",\n \"specialDiscountAmount\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"earlyPaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatAmount\": \"\",\n \"surchargeEquivalencePct\": \"\",\n \"surchargeEquivalenceAmount\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"withholdingTaxAmount\": \"\",\n \"shippingAmount\": \"\",\n \"financingPct\": \"\",\n \"financingAmount\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"commercialTotalAmount\": \"\",\n \"total\": \"\",\n \"totalPaid\": \"\",\n \"outstandingAmount\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"currencyDecimals\": \"\",\n \"currencyDecimalsSystem\": \"\",\n \"exchangeRate\": \"\",\n \"grossAmountSystem\": \"\",\n \"discountAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"roundingMode\": \"\",\n \"relationConcept\": \"\",\n \"relationType\": \"\",\n \"linkableQuantity\": \"\",\n \"relationQuantity\": \"\",\n \"totalApprovals\": \"\",\n \"validatedApprovals\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"REPAIR_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"CLAIM\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"RI\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"CP\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"grossAmount\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatPct\": \"\",\n \"vatAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"surchargePct\": \"\",\n \"surchargeAmount\": \"\",\n \"total\": \"\",\n \"commercialTotalAmount\": \"\",\n \"discounts\": [\n {\n \"type\": \"INSURER\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"id\": \"\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n }\n ],\n \"appliedPriceRule\": {\n \"id\": \"\",\n \"ruleType\": \"DISCOUNT\",\n \"tariffId\": \"\",\n \"tariffName\": \"\",\n \"comboId\": \"\",\n \"comboName\": \"\",\n \"purchaseCondition\": \"\",\n \"purchaseConditionId\": \"\",\n \"discountConditionId\": \"\",\n \"discountValue\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ]\n },\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"grossAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"reservedQuantity\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"QUOTE\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"MANUFACTURING_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"opticalOrderId\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"grossAmount\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatPct\": \"\",\n \"vatAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"surchargePct\": \"\",\n \"surchargeAmount\": \"\",\n \"total\": \"\",\n \"commercialTotalAmount\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n },\n {\n \"type\": \"PIN\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n }\n ],\n \"appliedPriceRule\": {\n \"id\": \"\",\n \"ruleType\": \"PIN\",\n \"tariffId\": \"\",\n \"tariffName\": \"\",\n \"comboId\": \"\",\n \"comboName\": \"\",\n \"purchaseCondition\": \"\",\n \"purchaseConditionId\": \"\",\n \"discountConditionId\": \"\",\n \"discountValue\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ]\n },\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"grossAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"reservedQuantity\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"CLAIM\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"REPAIR_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"opticalOrderId\": \"\"\n }\n ],\n \"carrierId\": \"\",\n \"carrierName\": \"\",\n \"carrierTaxId\": \"\",\n \"driverName\": \"\",\n \"vehicleId\": \"\",\n \"vehiclePlate\": \"\",\n \"vehicleModel\": \"\",\n \"shipmentNumber\": \"\",\n \"transportNote\": \"\",\n \"loadingNote\": \"\",\n \"quickReceive\": \"\",\n \"tareWeight\": \"\",\n \"grossWeight\": \"\",\n \"netWeight\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3d329800-36e4-4a2a-ac22-3ba4018705a6", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase delivery note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "295212b6-a7d6-424b-b525-ebbffb420db8", "name": "Authenticated user is missing the `VER_ALBARANESCOMPRA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase delivery note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5baac062-63d2-4f1f-888e-de24ecdd9393", "name": "Purchase delivery note not found", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase delivery note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "da22f3d1-abd8-4551-a37e-e613aa7a0fee", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase delivery note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ea16752d-a44c-488a-9a10-46f5bdc857bb", "name": "Update purchase delivery note", "request": { "name": "Update purchase delivery note", "description": { "content": "Full replacement of an existing purchase delivery note. Send the `If-Match` header with the current ETag for optimistic concurrency control. The `issued` flag is forced to `false` server-side.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "purchase-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Purchase delivery note ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"INCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"INVOICE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"carrierId\": \"\",\n \"driverName\": \"\",\n \"vehicleId\": \"\",\n \"vehiclePlate\": \"\",\n \"shipmentNumber\": \"\",\n \"transportNote\": \"\",\n \"loadingNote\": \"\",\n \"tareWeight\": \"\",\n \"grossWeight\": \"\",\n \"netWeight\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "c6c1f996-ca7d-4b2c-ba93-61f870aab8d1", "name": "Purchase delivery note updated", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase delivery note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"INCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"INVOICE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"carrierId\": \"\",\n \"driverName\": \"\",\n \"vehicleId\": \"\",\n \"vehiclePlate\": \"\",\n \"shipmentNumber\": \"\",\n \"transportNote\": \"\",\n \"loadingNote\": \"\",\n \"tareWeight\": \"\",\n \"grossWeight\": \"\",\n \"netWeight\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"documentType\": \"INVOICE\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"deliveryStatus\": \"EP\",\n \"lifecycleStatus\": \"\",\n \"paymentStatus\": \"OVERPAID\",\n \"documentStatusId\": \"\",\n \"documentStatusName\": \"\",\n \"issued\": \"\",\n \"draft\": \"\",\n \"enabled\": \"\",\n \"verified\": \"\",\n \"documentDate\": \"\",\n \"shippingDate\": \"\",\n \"counterpartyName\": \"\",\n \"counterpartyTaxId\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"companyTaxId\": \"\",\n \"warehouseName\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"optometristId\": \"\",\n \"optometristName\": \"\",\n \"documentTypeId\": \"\",\n \"documentTypeName\": \"\",\n \"paymentTermsId\": \"\",\n \"paymentTermsName\": \"\",\n \"basePriceListId\": \"\",\n \"basePriceListName\": \"\",\n \"discountPriceListId\": \"\",\n \"discountPriceListName\": \"\",\n \"taxBehavior\": \"INCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"withholdingTaxTypeName\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"totalQuantity\": \"\",\n \"grossAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"discountAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"specialDiscountPct\": \"\",\n \"specialDiscountAmount\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"earlyPaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatAmount\": \"\",\n \"surchargeEquivalencePct\": \"\",\n \"surchargeEquivalenceAmount\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"withholdingTaxAmount\": \"\",\n \"shippingAmount\": \"\",\n \"financingPct\": \"\",\n \"financingAmount\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"commercialTotalAmount\": \"\",\n \"total\": \"\",\n \"totalPaid\": \"\",\n \"outstandingAmount\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"currencyDecimals\": \"\",\n \"currencyDecimalsSystem\": \"\",\n \"exchangeRate\": \"\",\n \"grossAmountSystem\": \"\",\n \"discountAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"roundingMode\": \"\",\n \"relationConcept\": \"\",\n \"relationType\": \"\",\n \"linkableQuantity\": \"\",\n \"relationQuantity\": \"\",\n \"totalApprovals\": \"\",\n \"validatedApprovals\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"REPAIR_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"CLAIM\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"RI\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"CP\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"grossAmount\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatPct\": \"\",\n \"vatAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"surchargePct\": \"\",\n \"surchargeAmount\": \"\",\n \"total\": \"\",\n \"commercialTotalAmount\": \"\",\n \"discounts\": [\n {\n \"type\": \"INSURER\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"id\": \"\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n }\n ],\n \"appliedPriceRule\": {\n \"id\": \"\",\n \"ruleType\": \"DISCOUNT\",\n \"tariffId\": \"\",\n \"tariffName\": \"\",\n \"comboId\": \"\",\n \"comboName\": \"\",\n \"purchaseCondition\": \"\",\n \"purchaseConditionId\": \"\",\n \"discountConditionId\": \"\",\n \"discountValue\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ]\n },\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"grossAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"reservedQuantity\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"QUOTE\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"MANUFACTURING_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"opticalOrderId\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"grossAmount\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatPct\": \"\",\n \"vatAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"surchargePct\": \"\",\n \"surchargeAmount\": \"\",\n \"total\": \"\",\n \"commercialTotalAmount\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n },\n {\n \"type\": \"PIN\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n }\n ],\n \"appliedPriceRule\": {\n \"id\": \"\",\n \"ruleType\": \"PIN\",\n \"tariffId\": \"\",\n \"tariffName\": \"\",\n \"comboId\": \"\",\n \"comboName\": \"\",\n \"purchaseCondition\": \"\",\n \"purchaseConditionId\": \"\",\n \"discountConditionId\": \"\",\n \"discountValue\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ]\n },\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"grossAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"reservedQuantity\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"CLAIM\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"REPAIR_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"opticalOrderId\": \"\"\n }\n ],\n \"carrierId\": \"\",\n \"carrierName\": \"\",\n \"carrierTaxId\": \"\",\n \"driverName\": \"\",\n \"vehicleId\": \"\",\n \"vehiclePlate\": \"\",\n \"vehicleModel\": \"\",\n \"shipmentNumber\": \"\",\n \"transportNote\": \"\",\n \"loadingNote\": \"\",\n \"quickReceive\": \"\",\n \"tareWeight\": \"\",\n \"grossWeight\": \"\",\n \"netWeight\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "56d991c7-84e1-4984-8109-e7366b4ee685", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase delivery note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"INCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"INVOICE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"carrierId\": \"\",\n \"driverName\": \"\",\n \"vehicleId\": \"\",\n \"vehiclePlate\": \"\",\n \"shipmentNumber\": \"\",\n \"transportNote\": \"\",\n \"loadingNote\": \"\",\n \"tareWeight\": \"\",\n \"grossWeight\": \"\",\n \"netWeight\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "617c1d91-8664-4c07-804f-472ac112ea8c", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase delivery note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"INCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"INVOICE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"carrierId\": \"\",\n \"driverName\": \"\",\n \"vehicleId\": \"\",\n \"vehiclePlate\": \"\",\n \"shipmentNumber\": \"\",\n \"transportNote\": \"\",\n \"loadingNote\": \"\",\n \"tareWeight\": \"\",\n \"grossWeight\": \"\",\n \"netWeight\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1350d98d-3e25-46eb-857f-986e7c05c667", "name": "Authenticated user is missing the `EDITAR_ALBARANESCOMPRA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase delivery note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"INCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"INVOICE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"carrierId\": \"\",\n \"driverName\": \"\",\n \"vehicleId\": \"\",\n \"vehiclePlate\": \"\",\n \"shipmentNumber\": \"\",\n \"transportNote\": \"\",\n \"loadingNote\": \"\",\n \"tareWeight\": \"\",\n \"grossWeight\": \"\",\n \"netWeight\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "44683de7-4f90-40ef-b699-110fa71308dd", "name": "Purchase delivery note not found", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase delivery note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"INCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"INVOICE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"carrierId\": \"\",\n \"driverName\": \"\",\n \"vehicleId\": \"\",\n \"vehiclePlate\": \"\",\n \"shipmentNumber\": \"\",\n \"transportNote\": \"\",\n \"loadingNote\": \"\",\n \"tareWeight\": \"\",\n \"grossWeight\": \"\",\n \"netWeight\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9d6d3838-71c0-407b-8e79-3208bc61ae9e", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase delivery note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"INCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"INVOICE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"carrierId\": \"\",\n \"driverName\": \"\",\n \"vehicleId\": \"\",\n \"vehiclePlate\": \"\",\n \"shipmentNumber\": \"\",\n \"transportNote\": \"\",\n \"loadingNote\": \"\",\n \"tareWeight\": \"\",\n \"grossWeight\": \"\",\n \"netWeight\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ad0ddc8f-e4ec-4ee4-9cdf-d23c860e08aa", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase delivery note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"INCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"INVOICE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"carrierId\": \"\",\n \"driverName\": \"\",\n \"vehicleId\": \"\",\n \"vehiclePlate\": \"\",\n \"shipmentNumber\": \"\",\n \"transportNote\": \"\",\n \"loadingNote\": \"\",\n \"tareWeight\": \"\",\n \"grossWeight\": \"\",\n \"netWeight\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6d27f6d0-9688-418d-984d-5fe68e7cecd8", "name": "Delete purchase delivery note", "request": { "name": "Delete purchase delivery note", "description": { "content": "Deletes a purchase delivery note. Send the `If-Match` header with the current ETag for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "purchase-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Purchase delivery note ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "2704e99c-0d7a-42a3-a8b3-2e16ae52cedc", "name": "Purchase delivery note deleted", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase delivery note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7d7fa5ed-dd31-4c78-9450-e02448a651f6", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase delivery note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "26779d42-c009-4f82-974d-ec6728d647dc", "name": "Authenticated user is missing the `BORRAR_ALBARANESCOMPRA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase delivery note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b5aaa643-3027-4c49-af01-4f9680eacd91", "name": "Purchase delivery note not found", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase delivery note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f7f6cc0d-3ec5-4e53-b5a9-68045fd7302c", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase delivery note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "556d62da-047d-41dd-9afb-d61e9c78f47f", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase delivery note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9d78f191-1c7c-4bce-820a-13c0ffbd6a2a", "name": "Merge-patch purchase delivery note", "request": { "name": "Merge-patch purchase delivery note", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "purchase-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Purchase delivery note ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "2abc10ad-8ac1-4e4d-8578-aaa10e354316", "name": "Purchase delivery note patched", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase delivery note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"documentType\": \"INVOICE\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"deliveryStatus\": \"EP\",\n \"lifecycleStatus\": \"\",\n \"paymentStatus\": \"OVERPAID\",\n \"documentStatusId\": \"\",\n \"documentStatusName\": \"\",\n \"issued\": \"\",\n \"draft\": \"\",\n \"enabled\": \"\",\n \"verified\": \"\",\n \"documentDate\": \"\",\n \"shippingDate\": \"\",\n \"counterpartyName\": \"\",\n \"counterpartyTaxId\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"companyTaxId\": \"\",\n \"warehouseName\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"optometristId\": \"\",\n \"optometristName\": \"\",\n \"documentTypeId\": \"\",\n \"documentTypeName\": \"\",\n \"paymentTermsId\": \"\",\n \"paymentTermsName\": \"\",\n \"basePriceListId\": \"\",\n \"basePriceListName\": \"\",\n \"discountPriceListId\": \"\",\n \"discountPriceListName\": \"\",\n \"taxBehavior\": \"INCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"withholdingTaxTypeName\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"totalQuantity\": \"\",\n \"grossAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"discountAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"specialDiscountPct\": \"\",\n \"specialDiscountAmount\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"earlyPaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatAmount\": \"\",\n \"surchargeEquivalencePct\": \"\",\n \"surchargeEquivalenceAmount\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"withholdingTaxAmount\": \"\",\n \"shippingAmount\": \"\",\n \"financingPct\": \"\",\n \"financingAmount\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"commercialTotalAmount\": \"\",\n \"total\": \"\",\n \"totalPaid\": \"\",\n \"outstandingAmount\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"currencyDecimals\": \"\",\n \"currencyDecimalsSystem\": \"\",\n \"exchangeRate\": \"\",\n \"grossAmountSystem\": \"\",\n \"discountAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"roundingMode\": \"\",\n \"relationConcept\": \"\",\n \"relationType\": \"\",\n \"linkableQuantity\": \"\",\n \"relationQuantity\": \"\",\n \"totalApprovals\": \"\",\n \"validatedApprovals\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"REPAIR_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"CLAIM\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"RI\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"CP\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"grossAmount\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatPct\": \"\",\n \"vatAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"surchargePct\": \"\",\n \"surchargeAmount\": \"\",\n \"total\": \"\",\n \"commercialTotalAmount\": \"\",\n \"discounts\": [\n {\n \"type\": \"INSURER\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"id\": \"\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n }\n ],\n \"appliedPriceRule\": {\n \"id\": \"\",\n \"ruleType\": \"DISCOUNT\",\n \"tariffId\": \"\",\n \"tariffName\": \"\",\n \"comboId\": \"\",\n \"comboName\": \"\",\n \"purchaseCondition\": \"\",\n \"purchaseConditionId\": \"\",\n \"discountConditionId\": \"\",\n \"discountValue\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ]\n },\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"grossAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"reservedQuantity\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"QUOTE\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"MANUFACTURING_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"opticalOrderId\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"grossAmount\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatPct\": \"\",\n \"vatAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"surchargePct\": \"\",\n \"surchargeAmount\": \"\",\n \"total\": \"\",\n \"commercialTotalAmount\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n },\n {\n \"type\": \"PIN\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n }\n ],\n \"appliedPriceRule\": {\n \"id\": \"\",\n \"ruleType\": \"PIN\",\n \"tariffId\": \"\",\n \"tariffName\": \"\",\n \"comboId\": \"\",\n \"comboName\": \"\",\n \"purchaseCondition\": \"\",\n \"purchaseConditionId\": \"\",\n \"discountConditionId\": \"\",\n \"discountValue\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ]\n },\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"grossAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"reservedQuantity\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"CLAIM\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"REPAIR_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"opticalOrderId\": \"\"\n }\n ],\n \"carrierId\": \"\",\n \"carrierName\": \"\",\n \"carrierTaxId\": \"\",\n \"driverName\": \"\",\n \"vehicleId\": \"\",\n \"vehiclePlate\": \"\",\n \"vehicleModel\": \"\",\n \"shipmentNumber\": \"\",\n \"transportNote\": \"\",\n \"loadingNote\": \"\",\n \"quickReceive\": \"\",\n \"tareWeight\": \"\",\n \"grossWeight\": \"\",\n \"netWeight\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "52575d2e-a124-4edf-aae4-e9d4899c5769", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details. Also returned for malformed merge-patch payloads.", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase delivery note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2c8db51c-015a-4109-b6cd-d84ee934a361", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase delivery note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6eef831a-1afe-4de1-a97b-61d72a726d56", "name": "Authenticated user is missing the `EDITAR_ALBARANESCOMPRA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase delivery note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f096f38b-d122-419b-a830-1d6b3ea63e87", "name": "Purchase delivery note not found", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase delivery note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "577309c3-f002-4e47-9bf3-2b797cc79758", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase delivery note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a8f692ce-9121-4101-b63f-84d6af6a035f", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-delivery-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase delivery note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "b729f78e-bc68-4ff8-b7cd-355876c47c6c", "name": "List purchase delivery notes", "request": { "name": "List purchase delivery notes", "description": { "content": "Returns a paginated list of supplier purchase delivery notes with envelope `{data, totalCount, skip, limit, hasMore}`. Supports optional RSQL `filter`, `sort` (default `lastModifiedAt:desc`), `skip`/`limit` pagination and `modifiedAfter`/`modifiedBefore` bookends. Limit is capped at 200; skip is clamped to >= 0. The constraint `issued==false` is always enforced server-side.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "purchase-delivery-notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "6aedcda7-25a6-4487-bfc0-f078cd9dca21", "name": "Page of purchase delivery notes", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-delivery-notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "97691d86-14b4-49a4-994b-41ed760d9a46", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-delivery-notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8ef37561-b049-4671-8d99-9012f0ef4db2", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-delivery-notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d17d1c7b-db1d-47f2-aec3-3b91a9e22b4f", "name": "Authenticated user is missing the `VER_ALBARANESCOMPRA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-delivery-notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cbfd348e-5bc8-4035-8c5d-0acf19ea0724", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-delivery-notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4f388703-6257-4e94-8517-4a8a195b44e0", "name": "Create purchase delivery note", "request": { "name": "Create purchase delivery note", "description": { "content": "Creates a new supplier purchase delivery note with the provided data and optional line items and prepayments. The `issued` flag is forced to `false` server-side regardless of the request payload.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "purchase-delivery-notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"INCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"INVOICE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"carrierId\": \"\",\n \"driverName\": \"\",\n \"vehicleId\": \"\",\n \"vehiclePlate\": \"\",\n \"shipmentNumber\": \"\",\n \"transportNote\": \"\",\n \"loadingNote\": \"\",\n \"tareWeight\": \"\",\n \"grossWeight\": \"\",\n \"netWeight\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "d2ea31e5-767e-43a8-ad3f-f5a771d9b784", "name": "Purchase delivery note created", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-delivery-notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"INCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"INVOICE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"carrierId\": \"\",\n \"driverName\": \"\",\n \"vehicleId\": \"\",\n \"vehiclePlate\": \"\",\n \"shipmentNumber\": \"\",\n \"transportNote\": \"\",\n \"loadingNote\": \"\",\n \"tareWeight\": \"\",\n \"grossWeight\": \"\",\n \"netWeight\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"documentType\": \"INVOICE\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"deliveryStatus\": \"EP\",\n \"lifecycleStatus\": \"\",\n \"paymentStatus\": \"OVERPAID\",\n \"documentStatusId\": \"\",\n \"documentStatusName\": \"\",\n \"issued\": \"\",\n \"draft\": \"\",\n \"enabled\": \"\",\n \"verified\": \"\",\n \"documentDate\": \"\",\n \"shippingDate\": \"\",\n \"counterpartyName\": \"\",\n \"counterpartyTaxId\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"companyTaxId\": \"\",\n \"warehouseName\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"optometristId\": \"\",\n \"optometristName\": \"\",\n \"documentTypeId\": \"\",\n \"documentTypeName\": \"\",\n \"paymentTermsId\": \"\",\n \"paymentTermsName\": \"\",\n \"basePriceListId\": \"\",\n \"basePriceListName\": \"\",\n \"discountPriceListId\": \"\",\n \"discountPriceListName\": \"\",\n \"taxBehavior\": \"INCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"withholdingTaxTypeName\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"totalQuantity\": \"\",\n \"grossAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"discountAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"specialDiscountPct\": \"\",\n \"specialDiscountAmount\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"earlyPaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatAmount\": \"\",\n \"surchargeEquivalencePct\": \"\",\n \"surchargeEquivalenceAmount\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"withholdingTaxAmount\": \"\",\n \"shippingAmount\": \"\",\n \"financingPct\": \"\",\n \"financingAmount\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"commercialTotalAmount\": \"\",\n \"total\": \"\",\n \"totalPaid\": \"\",\n \"outstandingAmount\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"currencyDecimals\": \"\",\n \"currencyDecimalsSystem\": \"\",\n \"exchangeRate\": \"\",\n \"grossAmountSystem\": \"\",\n \"discountAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"roundingMode\": \"\",\n \"relationConcept\": \"\",\n \"relationType\": \"\",\n \"linkableQuantity\": \"\",\n \"relationQuantity\": \"\",\n \"totalApprovals\": \"\",\n \"validatedApprovals\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"REPAIR_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"CLAIM\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"RI\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"CP\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"grossAmount\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatPct\": \"\",\n \"vatAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"surchargePct\": \"\",\n \"surchargeAmount\": \"\",\n \"total\": \"\",\n \"commercialTotalAmount\": \"\",\n \"discounts\": [\n {\n \"type\": \"INSURER\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"id\": \"\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n }\n ],\n \"appliedPriceRule\": {\n \"id\": \"\",\n \"ruleType\": \"DISCOUNT\",\n \"tariffId\": \"\",\n \"tariffName\": \"\",\n \"comboId\": \"\",\n \"comboName\": \"\",\n \"purchaseCondition\": \"\",\n \"purchaseConditionId\": \"\",\n \"discountConditionId\": \"\",\n \"discountValue\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ]\n },\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"grossAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"reservedQuantity\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"QUOTE\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"MANUFACTURING_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"opticalOrderId\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"grossAmount\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"commercialNetAmount\": \"\",\n \"copaymentDiscount\": \"\",\n \"netAmount\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatPct\": \"\",\n \"vatAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"surchargeTypeName\": \"\",\n \"surchargePct\": \"\",\n \"surchargeAmount\": \"\",\n \"total\": \"\",\n \"commercialTotalAmount\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n },\n {\n \"type\": \"PIN\",\n \"id\": \"\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"accountId\": \"\"\n }\n ],\n \"appliedPriceRule\": {\n \"id\": \"\",\n \"ruleType\": \"PIN\",\n \"tariffId\": \"\",\n \"tariffName\": \"\",\n \"comboId\": \"\",\n \"comboName\": \"\",\n \"purchaseCondition\": \"\",\n \"purchaseConditionId\": \"\",\n \"discountConditionId\": \"\",\n \"discountValue\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ]\n },\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"grossAmountSystem\": \"\",\n \"netAmountSystem\": \"\",\n \"vatAmountSystem\": \"\",\n \"totalSystem\": \"\",\n \"reservedQuantity\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"relatedDocuments\": [\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"CLAIM\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n },\n {\n \"id\": \"\",\n \"relatedDocumentId\": \"\",\n \"relatedDocumentType\": \"REPAIR_ORDER\",\n \"concept\": \"\",\n \"relationType\": \"\",\n \"quantity\": \"\",\n \"documentDate\": \"\",\n \"manual\": \"\",\n \"externalDocumentNumber\": \"\"\n }\n ],\n \"opticalOrderId\": \"\"\n }\n ],\n \"carrierId\": \"\",\n \"carrierName\": \"\",\n \"carrierTaxId\": \"\",\n \"driverName\": \"\",\n \"vehicleId\": \"\",\n \"vehiclePlate\": \"\",\n \"vehicleModel\": \"\",\n \"shipmentNumber\": \"\",\n \"transportNote\": \"\",\n \"loadingNote\": \"\",\n \"quickReceive\": \"\",\n \"tareWeight\": \"\",\n \"grossWeight\": \"\",\n \"netWeight\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c62dc524-25f9-4d16-a7ac-a65798412c7e", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-delivery-notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"INCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"INVOICE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"carrierId\": \"\",\n \"driverName\": \"\",\n \"vehicleId\": \"\",\n \"vehiclePlate\": \"\",\n \"shipmentNumber\": \"\",\n \"transportNote\": \"\",\n \"loadingNote\": \"\",\n \"tareWeight\": \"\",\n \"grossWeight\": \"\",\n \"netWeight\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b4cc4ee7-6aef-434f-a668-3ae7a4e83f23", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-delivery-notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"INCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"INVOICE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"carrierId\": \"\",\n \"driverName\": \"\",\n \"vehicleId\": \"\",\n \"vehiclePlate\": \"\",\n \"shipmentNumber\": \"\",\n \"transportNote\": \"\",\n \"loadingNote\": \"\",\n \"tareWeight\": \"\",\n \"grossWeight\": \"\",\n \"netWeight\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ff860626-759e-4107-b649-ebeade1d3b9f", "name": "Authenticated user is missing the `CREAR_ALBARANESCOMPRA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-delivery-notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"INCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"INVOICE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"carrierId\": \"\",\n \"driverName\": \"\",\n \"vehicleId\": \"\",\n \"vehiclePlate\": \"\",\n \"shipmentNumber\": \"\",\n \"transportNote\": \"\",\n \"loadingNote\": \"\",\n \"tareWeight\": \"\",\n \"grossWeight\": \"\",\n \"netWeight\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "df4bf2f4-380c-40c8-bb2c-057d3d4717bd", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "purchase-delivery-notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"counterpartyId\": \"\",\n \"warehouseId\": \"\",\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"issued\": \"\",\n \"documentDate\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"companyId\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"employeeId\": \"\",\n \"optometristId\": \"\",\n \"documentTypeId\": \"\",\n \"paymentTermsId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"taxBehavior\": \"INCLUDED\",\n \"withholdingTaxTypeId\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"earlyPaymentDiscountPct\": \"\",\n \"withholdingTaxBase\": \"\",\n \"withholdingTaxPct\": \"\",\n \"withholdingOnFullNet\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"INSURER\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"ORDER\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"id\": \"\",\n \"productName\": \"\",\n \"productDescription\": \"\",\n \"extendedDescription\": \"\",\n \"packs\": \"\",\n \"batch\": \"\",\n \"expirationDate\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"vatTypeId\": \"\",\n \"manualVatAmount\": \"\",\n \"manualSurchargeAmount\": \"\",\n \"surchargeTypeId\": \"\",\n \"discounts\": [\n {\n \"type\": \"COMBO\",\n \"mode\": \"PCT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n },\n {\n \"type\": \"DISCOUNT\",\n \"mode\": \"AMOUNT\",\n \"pct\": \"\",\n \"amount\": \"\",\n \"amountTaxIncluded\": \"\",\n \"capTaxIncluded\": \"\",\n \"insurerId\": \"\"\n }\n ],\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"excludePin\": \"\",\n \"campaignId\": \"\",\n \"vatAccountId\": \"\",\n \"surchargeAccountId\": \"\",\n \"revenueAccountId\": \"\",\n \"baseType\": \"INVOICE\",\n \"baseEntry\": \"\",\n \"baseLine\": \"\",\n \"baseQuantity\": \"\"\n }\n ],\n \"carrierId\": \"\",\n \"driverName\": \"\",\n \"vehicleId\": \"\",\n \"vehiclePlate\": \"\",\n \"shipmentNumber\": \"\",\n \"transportNote\": \"\",\n \"loadingNote\": \"\",\n \"tareWeight\": \"\",\n \"grossWeight\": \"\",\n \"netWeight\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "products", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "b0243b17-56cc-4cd5-979e-8c4f6a33f385", "name": "Get product by ID", "request": { "name": "Get product by ID", "description": { "content": "Returns a single product with the FULL graph: header fields, variants, product-level and variant-level custom field values, stock summary per branch and supplier prices. Carries a strong `ETag` header with the current version.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Product ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "49566643-dd7a-45ee-86a7-5ab73b75c96e", "name": "Product found", "originalRequest": { "url": { "path": [ "api", "v2", "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"modelCode\": \"\",\n \"reference\": \"\",\n \"alias\": \"\",\n \"cabysCode\": \"\",\n \"externalId\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"blockType\": \"\",\n \"manufacturable\": \"\",\n \"inventoriable\": \"\",\n \"needsRawMaterial\": \"\",\n \"batchRequired\": \"\",\n \"priceEditable\": \"\",\n \"online\": \"\",\n \"fabricabilityByVariant\": \"\",\n \"material\": \"\",\n \"frameType\": \"\",\n \"gender\": \"\",\n \"usefulLifeDays\": \"\",\n \"currencyCode\": \"\",\n \"systemCurrencyCode\": \"\",\n \"lensIndex\": \"\",\n \"lensStrx\": \"\",\n \"lensMaterial\": \"\",\n \"lensShape\": \"\",\n \"onlineName\": \"\",\n \"shortDescription\": \"\",\n \"extendedDescription\": \"\",\n \"linkRewrite\": \"\",\n \"webStockManagementType\": \"\",\n \"webVisibilityType\": \"\",\n \"onlineChannelIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"supplierId\": \"\",\n \"supplierName\": \"\",\n \"categoryId\": \"\",\n \"categoryName\": \"\",\n \"brandId\": \"\",\n \"brandName\": \"\",\n \"groupId\": \"\",\n \"groupName\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"collectionId\": \"\",\n \"collectionName\": \"\",\n \"rangeId\": \"\",\n \"rangeName\": \"\",\n \"itemTypeId\": \"\",\n \"itemTypeName\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatRate\": \"\",\n \"categories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"defaultVariantId\": \"\",\n \"defaultImageId\": \"\",\n \"caseProductId\": \"\",\n \"caseProductName\": \"\",\n \"workOrderProductId\": \"\",\n \"workOrderProductName\": \"\",\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"valueType\": \"\",\n \"value\": \"\",\n \"optionId\": \"\",\n \"optionLabel\": \"\",\n \"optionHex\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"valueType\": \"\",\n \"value\": \"\",\n \"optionId\": \"\",\n \"optionLabel\": \"\",\n \"optionHex\": \"\"\n }\n ],\n \"variantCustomFieldIds\": [\n \"\",\n \"\"\n ],\n \"manufacturingFieldIds\": [\n \"\",\n \"\"\n ],\n \"variants\": [\n {\n \"id\": \"\",\n \"version\": \"\",\n \"barCode\": \"\",\n \"gtin\": \"\",\n \"reference\": \"\",\n \"description\": \"\",\n \"supplierDescription\": \"\",\n \"color\": \"\",\n \"rod\": \"\",\n \"bridge\": \"\",\n \"horizontalDiameter\": \"\",\n \"verticalDiameter\": \"\",\n \"usefulLifeDays\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"discontinued\": \"\",\n \"batch\": \"\",\n \"inventoriable\": \"\",\n \"priceEditable\": \"\",\n \"purchasePriceNet\": \"\",\n \"purchasePriceGross\": \"\",\n \"salePriceNet\": \"\",\n \"salePriceGross\": \"\",\n \"factor\": \"\",\n \"margin\": \"\",\n \"vatTypeId\": \"\",\n \"vatRate\": \"\",\n \"purchasePriceSystem\": \"\",\n \"salePriceSystem\": \"\",\n \"salePriceGrossSystem\": \"\",\n \"exchangeRate\": \"\",\n \"packQuantity\": \"\",\n \"packProductId\": \"\",\n \"defaultImageId\": \"\",\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"valueType\": \"\",\n \"value\": \"\",\n \"optionId\": \"\",\n \"optionLabel\": \"\",\n \"optionHex\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"valueType\": \"\",\n \"value\": \"\",\n \"optionId\": \"\",\n \"optionLabel\": \"\",\n \"optionHex\": \"\"\n }\n ],\n \"stockLevels\": [\n {\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"currentQuantity\": \"\",\n \"reservedQuantity\": \"\",\n \"minimumStock\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"currentQuantity\": \"\",\n \"reservedQuantity\": \"\",\n \"minimumStock\": \"\"\n }\n ],\n \"supplierPrices\": [\n {\n \"id\": \"\",\n \"supplierId\": \"\",\n \"supplierName\": \"\",\n \"reference\": \"\",\n \"price\": \"\",\n \"lastPurchaseDate\": \"\"\n },\n {\n \"id\": \"\",\n \"supplierId\": \"\",\n \"supplierName\": \"\",\n \"reference\": \"\",\n \"price\": \"\",\n \"lastPurchaseDate\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n },\n {\n \"id\": \"\",\n \"version\": \"\",\n \"barCode\": \"\",\n \"gtin\": \"\",\n \"reference\": \"\",\n \"description\": \"\",\n \"supplierDescription\": \"\",\n \"color\": \"\",\n \"rod\": \"\",\n \"bridge\": \"\",\n \"horizontalDiameter\": \"\",\n \"verticalDiameter\": \"\",\n \"usefulLifeDays\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"discontinued\": \"\",\n \"batch\": \"\",\n \"inventoriable\": \"\",\n \"priceEditable\": \"\",\n \"purchasePriceNet\": \"\",\n \"purchasePriceGross\": \"\",\n \"salePriceNet\": \"\",\n \"salePriceGross\": \"\",\n \"factor\": \"\",\n \"margin\": \"\",\n \"vatTypeId\": \"\",\n \"vatRate\": \"\",\n \"purchasePriceSystem\": \"\",\n \"salePriceSystem\": \"\",\n \"salePriceGrossSystem\": \"\",\n \"exchangeRate\": \"\",\n \"packQuantity\": \"\",\n \"packProductId\": \"\",\n \"defaultImageId\": \"\",\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"valueType\": \"\",\n \"value\": \"\",\n \"optionId\": \"\",\n \"optionLabel\": \"\",\n \"optionHex\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"valueType\": \"\",\n \"value\": \"\",\n \"optionId\": \"\",\n \"optionLabel\": \"\",\n \"optionHex\": \"\"\n }\n ],\n \"stockLevels\": [\n {\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"currentQuantity\": \"\",\n \"reservedQuantity\": \"\",\n \"minimumStock\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"currentQuantity\": \"\",\n \"reservedQuantity\": \"\",\n \"minimumStock\": \"\"\n }\n ],\n \"supplierPrices\": [\n {\n \"id\": \"\",\n \"supplierId\": \"\",\n \"supplierName\": \"\",\n \"reference\": \"\",\n \"price\": \"\",\n \"lastPurchaseDate\": \"\"\n },\n {\n \"id\": \"\",\n \"supplierId\": \"\",\n \"supplierName\": \"\",\n \"reference\": \"\",\n \"price\": \"\",\n \"lastPurchaseDate\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"images\": [\n {\n \"id\": \"\",\n \"url\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"url\": \"\",\n \"name\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c8918387-0068-42ab-be7d-156b30d1d601", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2a6e6faf-0c91-4fec-be78-44dbb5a24301", "name": "Authenticated user is missing the `VER_MODELOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "574d8274-e839-4f68-a889-3e316f0d37aa", "name": "Product not found", "originalRequest": { "url": { "path": [ "api", "v2", "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "677b0bcf-9cb4-4c9a-a30c-555405a0da0f", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a4b38bbf-96ab-42f5-a09a-10e0dc5544d3", "name": "Update product", "request": { "name": "Update product", "description": { "content": "Full replacement of an existing product and its variants. Variants whose `id` is present in the payload are updated in place; new variants (no `id`) are created; existing variants whose id is absent from the payload are deleted. Send the `If-Match` header with the current ETag for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Product ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"modelCode\": \"\",\n \"reference\": \"\",\n \"alias\": \"\",\n \"cabysCode\": \"\",\n \"externalId\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"blockType\": \"\",\n \"manufacturable\": \"\",\n \"inventoriable\": \"\",\n \"needsRawMaterial\": \"\",\n \"batchRequired\": \"\",\n \"priceEditable\": \"\",\n \"online\": \"\",\n \"fabricabilityByVariant\": \"\",\n \"material\": \"\",\n \"frameType\": \"\",\n \"gender\": \"\",\n \"usefulLifeDays\": \"\",\n \"currencyCode\": \"\",\n \"systemCurrencyCode\": \"\",\n \"lensIndex\": \"\",\n \"lensStrx\": \"\",\n \"lensMaterial\": \"\",\n \"lensShape\": \"\",\n \"onlineName\": \"\",\n \"shortDescription\": \"\",\n \"extendedDescription\": \"\",\n \"linkRewrite\": \"\",\n \"webStockManagementType\": \"\",\n \"webVisibilityType\": \"\",\n \"onlineChannelIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\",\n \"supplierId\": \"\",\n \"categoryId\": \"\",\n \"brandId\": \"\",\n \"groupId\": \"\",\n \"campaignId\": \"\",\n \"collectionId\": \"\",\n \"rangeId\": \"\",\n \"itemTypeId\": \"\",\n \"vatTypeId\": \"\",\n \"additionalCategoryIds\": [\n \"\",\n \"\"\n ],\n \"defaultVariantId\": \"\",\n \"caseProductId\": \"\",\n \"workOrderProductId\": \"\",\n \"temporaryImageIds\": [\n \"\",\n \"\"\n ],\n \"defaultTemporaryImageId\": \"\",\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n }\n ],\n \"variantCustomFieldIds\": [\n \"\",\n \"\"\n ],\n \"manufacturingFieldIds\": [\n \"\",\n \"\"\n ],\n \"variants\": [\n {\n \"id\": \"\",\n \"barCode\": \"\",\n \"gtin\": \"\",\n \"reference\": \"\",\n \"description\": \"\",\n \"supplierDescription\": \"\",\n \"color\": \"\",\n \"rod\": \"\",\n \"bridge\": \"\",\n \"horizontalDiameter\": \"\",\n \"verticalDiameter\": \"\",\n \"usefulLifeDays\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"discontinued\": \"\",\n \"batch\": \"\",\n \"purchasePriceNet\": \"\",\n \"purchasePriceGross\": \"\",\n \"salePriceNet\": \"\",\n \"salePriceGross\": \"\",\n \"factor\": \"\",\n \"margin\": \"\",\n \"vatTypeId\": \"\",\n \"packQuantity\": \"\",\n \"packProductId\": \"\",\n \"temporaryImageIds\": [\n \"\",\n \"\"\n ],\n \"defaultTemporaryImageId\": \"\",\n \"defaultImageId\": \"\",\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n }\n ],\n \"stockMinimums\": [\n {\n \"warehouseId\": \"\",\n \"minimumStock\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"minimumStock\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"barCode\": \"\",\n \"gtin\": \"\",\n \"reference\": \"\",\n \"description\": \"\",\n \"supplierDescription\": \"\",\n \"color\": \"\",\n \"rod\": \"\",\n \"bridge\": \"\",\n \"horizontalDiameter\": \"\",\n \"verticalDiameter\": \"\",\n \"usefulLifeDays\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"discontinued\": \"\",\n \"batch\": \"\",\n \"purchasePriceNet\": \"\",\n \"purchasePriceGross\": \"\",\n \"salePriceNet\": \"\",\n \"salePriceGross\": \"\",\n \"factor\": \"\",\n \"margin\": \"\",\n \"vatTypeId\": \"\",\n \"packQuantity\": \"\",\n \"packProductId\": \"\",\n \"temporaryImageIds\": [\n \"\",\n \"\"\n ],\n \"defaultTemporaryImageId\": \"\",\n \"defaultImageId\": \"\",\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n }\n ],\n \"stockMinimums\": [\n {\n \"warehouseId\": \"\",\n \"minimumStock\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"minimumStock\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "ecea5ee1-1934-4781-b280-f3e2420ddb07", "name": "Product updated", "originalRequest": { "url": { "path": [ "api", "v2", "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"modelCode\": \"\",\n \"reference\": \"\",\n \"alias\": \"\",\n \"cabysCode\": \"\",\n \"externalId\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"blockType\": \"\",\n \"manufacturable\": \"\",\n \"inventoriable\": \"\",\n \"needsRawMaterial\": \"\",\n \"batchRequired\": \"\",\n \"priceEditable\": \"\",\n \"online\": \"\",\n \"fabricabilityByVariant\": \"\",\n \"material\": \"\",\n \"frameType\": \"\",\n \"gender\": \"\",\n \"usefulLifeDays\": \"\",\n \"currencyCode\": \"\",\n \"systemCurrencyCode\": \"\",\n \"lensIndex\": \"\",\n \"lensStrx\": \"\",\n \"lensMaterial\": \"\",\n \"lensShape\": \"\",\n \"onlineName\": \"\",\n \"shortDescription\": \"\",\n \"extendedDescription\": \"\",\n \"linkRewrite\": \"\",\n \"webStockManagementType\": \"\",\n \"webVisibilityType\": \"\",\n \"onlineChannelIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\",\n \"supplierId\": \"\",\n \"categoryId\": \"\",\n \"brandId\": \"\",\n \"groupId\": \"\",\n \"campaignId\": \"\",\n \"collectionId\": \"\",\n \"rangeId\": \"\",\n \"itemTypeId\": \"\",\n \"vatTypeId\": \"\",\n \"additionalCategoryIds\": [\n \"\",\n \"\"\n ],\n \"defaultVariantId\": \"\",\n \"caseProductId\": \"\",\n \"workOrderProductId\": \"\",\n \"temporaryImageIds\": [\n \"\",\n \"\"\n ],\n \"defaultTemporaryImageId\": \"\",\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n }\n ],\n \"variantCustomFieldIds\": [\n \"\",\n \"\"\n ],\n \"manufacturingFieldIds\": [\n \"\",\n \"\"\n ],\n \"variants\": [\n {\n \"id\": \"\",\n \"barCode\": \"\",\n \"gtin\": \"\",\n \"reference\": \"\",\n \"description\": \"\",\n \"supplierDescription\": \"\",\n \"color\": \"\",\n \"rod\": \"\",\n \"bridge\": \"\",\n \"horizontalDiameter\": \"\",\n \"verticalDiameter\": \"\",\n \"usefulLifeDays\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"discontinued\": \"\",\n \"batch\": \"\",\n \"purchasePriceNet\": \"\",\n \"purchasePriceGross\": \"\",\n \"salePriceNet\": \"\",\n \"salePriceGross\": \"\",\n \"factor\": \"\",\n \"margin\": \"\",\n \"vatTypeId\": \"\",\n \"packQuantity\": \"\",\n \"packProductId\": \"\",\n \"temporaryImageIds\": [\n \"\",\n \"\"\n ],\n \"defaultTemporaryImageId\": \"\",\n \"defaultImageId\": \"\",\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n }\n ],\n \"stockMinimums\": [\n {\n \"warehouseId\": \"\",\n \"minimumStock\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"minimumStock\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"barCode\": \"\",\n \"gtin\": \"\",\n \"reference\": \"\",\n \"description\": \"\",\n \"supplierDescription\": \"\",\n \"color\": \"\",\n \"rod\": \"\",\n \"bridge\": \"\",\n \"horizontalDiameter\": \"\",\n \"verticalDiameter\": \"\",\n \"usefulLifeDays\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"discontinued\": \"\",\n \"batch\": \"\",\n \"purchasePriceNet\": \"\",\n \"purchasePriceGross\": \"\",\n \"salePriceNet\": \"\",\n \"salePriceGross\": \"\",\n \"factor\": \"\",\n \"margin\": \"\",\n \"vatTypeId\": \"\",\n \"packQuantity\": \"\",\n \"packProductId\": \"\",\n \"temporaryImageIds\": [\n \"\",\n \"\"\n ],\n \"defaultTemporaryImageId\": \"\",\n \"defaultImageId\": \"\",\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n }\n ],\n \"stockMinimums\": [\n {\n \"warehouseId\": \"\",\n \"minimumStock\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"minimumStock\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"modelCode\": \"\",\n \"reference\": \"\",\n \"alias\": \"\",\n \"cabysCode\": \"\",\n \"externalId\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"blockType\": \"\",\n \"manufacturable\": \"\",\n \"inventoriable\": \"\",\n \"needsRawMaterial\": \"\",\n \"batchRequired\": \"\",\n \"priceEditable\": \"\",\n \"online\": \"\",\n \"fabricabilityByVariant\": \"\",\n \"material\": \"\",\n \"frameType\": \"\",\n \"gender\": \"\",\n \"usefulLifeDays\": \"\",\n \"currencyCode\": \"\",\n \"systemCurrencyCode\": \"\",\n \"lensIndex\": \"\",\n \"lensStrx\": \"\",\n \"lensMaterial\": \"\",\n \"lensShape\": \"\",\n \"onlineName\": \"\",\n \"shortDescription\": \"\",\n \"extendedDescription\": \"\",\n \"linkRewrite\": \"\",\n \"webStockManagementType\": \"\",\n \"webVisibilityType\": \"\",\n \"onlineChannelIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"supplierId\": \"\",\n \"supplierName\": \"\",\n \"categoryId\": \"\",\n \"categoryName\": \"\",\n \"brandId\": \"\",\n \"brandName\": \"\",\n \"groupId\": \"\",\n \"groupName\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"collectionId\": \"\",\n \"collectionName\": \"\",\n \"rangeId\": \"\",\n \"rangeName\": \"\",\n \"itemTypeId\": \"\",\n \"itemTypeName\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatRate\": \"\",\n \"categories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"defaultVariantId\": \"\",\n \"defaultImageId\": \"\",\n \"caseProductId\": \"\",\n \"caseProductName\": \"\",\n \"workOrderProductId\": \"\",\n \"workOrderProductName\": \"\",\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"valueType\": \"\",\n \"value\": \"\",\n \"optionId\": \"\",\n \"optionLabel\": \"\",\n \"optionHex\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"valueType\": \"\",\n \"value\": \"\",\n \"optionId\": \"\",\n \"optionLabel\": \"\",\n \"optionHex\": \"\"\n }\n ],\n \"variantCustomFieldIds\": [\n \"\",\n \"\"\n ],\n \"manufacturingFieldIds\": [\n \"\",\n \"\"\n ],\n \"variants\": [\n {\n \"id\": \"\",\n \"version\": \"\",\n \"barCode\": \"\",\n \"gtin\": \"\",\n \"reference\": \"\",\n \"description\": \"\",\n \"supplierDescription\": \"\",\n \"color\": \"\",\n \"rod\": \"\",\n \"bridge\": \"\",\n \"horizontalDiameter\": \"\",\n \"verticalDiameter\": \"\",\n \"usefulLifeDays\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"discontinued\": \"\",\n \"batch\": \"\",\n \"inventoriable\": \"\",\n \"priceEditable\": \"\",\n \"purchasePriceNet\": \"\",\n \"purchasePriceGross\": \"\",\n \"salePriceNet\": \"\",\n \"salePriceGross\": \"\",\n \"factor\": \"\",\n \"margin\": \"\",\n \"vatTypeId\": \"\",\n \"vatRate\": \"\",\n \"purchasePriceSystem\": \"\",\n \"salePriceSystem\": \"\",\n \"salePriceGrossSystem\": \"\",\n \"exchangeRate\": \"\",\n \"packQuantity\": \"\",\n \"packProductId\": \"\",\n \"defaultImageId\": \"\",\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"valueType\": \"\",\n \"value\": \"\",\n \"optionId\": \"\",\n \"optionLabel\": \"\",\n \"optionHex\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"valueType\": \"\",\n \"value\": \"\",\n \"optionId\": \"\",\n \"optionLabel\": \"\",\n \"optionHex\": \"\"\n }\n ],\n \"stockLevels\": [\n {\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"currentQuantity\": \"\",\n \"reservedQuantity\": \"\",\n \"minimumStock\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"currentQuantity\": \"\",\n \"reservedQuantity\": \"\",\n \"minimumStock\": \"\"\n }\n ],\n \"supplierPrices\": [\n {\n \"id\": \"\",\n \"supplierId\": \"\",\n \"supplierName\": \"\",\n \"reference\": \"\",\n \"price\": \"\",\n \"lastPurchaseDate\": \"\"\n },\n {\n \"id\": \"\",\n \"supplierId\": \"\",\n \"supplierName\": \"\",\n \"reference\": \"\",\n \"price\": \"\",\n \"lastPurchaseDate\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n },\n {\n \"id\": \"\",\n \"version\": \"\",\n \"barCode\": \"\",\n \"gtin\": \"\",\n \"reference\": \"\",\n \"description\": \"\",\n \"supplierDescription\": \"\",\n \"color\": \"\",\n \"rod\": \"\",\n \"bridge\": \"\",\n \"horizontalDiameter\": \"\",\n \"verticalDiameter\": \"\",\n \"usefulLifeDays\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"discontinued\": \"\",\n \"batch\": \"\",\n \"inventoriable\": \"\",\n \"priceEditable\": \"\",\n \"purchasePriceNet\": \"\",\n \"purchasePriceGross\": \"\",\n \"salePriceNet\": \"\",\n \"salePriceGross\": \"\",\n \"factor\": \"\",\n \"margin\": \"\",\n \"vatTypeId\": \"\",\n \"vatRate\": \"\",\n \"purchasePriceSystem\": \"\",\n \"salePriceSystem\": \"\",\n \"salePriceGrossSystem\": \"\",\n \"exchangeRate\": \"\",\n \"packQuantity\": \"\",\n \"packProductId\": \"\",\n \"defaultImageId\": \"\",\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"valueType\": \"\",\n \"value\": \"\",\n \"optionId\": \"\",\n \"optionLabel\": \"\",\n \"optionHex\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"valueType\": \"\",\n \"value\": \"\",\n \"optionId\": \"\",\n \"optionLabel\": \"\",\n \"optionHex\": \"\"\n }\n ],\n \"stockLevels\": [\n {\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"currentQuantity\": \"\",\n \"reservedQuantity\": \"\",\n \"minimumStock\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"currentQuantity\": \"\",\n \"reservedQuantity\": \"\",\n \"minimumStock\": \"\"\n }\n ],\n \"supplierPrices\": [\n {\n \"id\": \"\",\n \"supplierId\": \"\",\n \"supplierName\": \"\",\n \"reference\": \"\",\n \"price\": \"\",\n \"lastPurchaseDate\": \"\"\n },\n {\n \"id\": \"\",\n \"supplierId\": \"\",\n \"supplierName\": \"\",\n \"reference\": \"\",\n \"price\": \"\",\n \"lastPurchaseDate\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"images\": [\n {\n \"id\": \"\",\n \"url\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"url\": \"\",\n \"name\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "94d48d60-f41f-4909-a597-c5cbc7b2ebaf", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"modelCode\": \"\",\n \"reference\": \"\",\n \"alias\": \"\",\n \"cabysCode\": \"\",\n \"externalId\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"blockType\": \"\",\n \"manufacturable\": \"\",\n \"inventoriable\": \"\",\n \"needsRawMaterial\": \"\",\n \"batchRequired\": \"\",\n \"priceEditable\": \"\",\n \"online\": \"\",\n \"fabricabilityByVariant\": \"\",\n \"material\": \"\",\n \"frameType\": \"\",\n \"gender\": \"\",\n \"usefulLifeDays\": \"\",\n \"currencyCode\": \"\",\n \"systemCurrencyCode\": \"\",\n \"lensIndex\": \"\",\n \"lensStrx\": \"\",\n \"lensMaterial\": \"\",\n \"lensShape\": \"\",\n \"onlineName\": \"\",\n \"shortDescription\": \"\",\n \"extendedDescription\": \"\",\n \"linkRewrite\": \"\",\n \"webStockManagementType\": \"\",\n \"webVisibilityType\": \"\",\n \"onlineChannelIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\",\n \"supplierId\": \"\",\n \"categoryId\": \"\",\n \"brandId\": \"\",\n \"groupId\": \"\",\n \"campaignId\": \"\",\n \"collectionId\": \"\",\n \"rangeId\": \"\",\n \"itemTypeId\": \"\",\n \"vatTypeId\": \"\",\n \"additionalCategoryIds\": [\n \"\",\n \"\"\n ],\n \"defaultVariantId\": \"\",\n \"caseProductId\": \"\",\n \"workOrderProductId\": \"\",\n \"temporaryImageIds\": [\n \"\",\n \"\"\n ],\n \"defaultTemporaryImageId\": \"\",\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n }\n ],\n \"variantCustomFieldIds\": [\n \"\",\n \"\"\n ],\n \"manufacturingFieldIds\": [\n \"\",\n \"\"\n ],\n \"variants\": [\n {\n \"id\": \"\",\n \"barCode\": \"\",\n \"gtin\": \"\",\n \"reference\": \"\",\n \"description\": \"\",\n \"supplierDescription\": \"\",\n \"color\": \"\",\n \"rod\": \"\",\n \"bridge\": \"\",\n \"horizontalDiameter\": \"\",\n \"verticalDiameter\": \"\",\n \"usefulLifeDays\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"discontinued\": \"\",\n \"batch\": \"\",\n \"purchasePriceNet\": \"\",\n \"purchasePriceGross\": \"\",\n \"salePriceNet\": \"\",\n \"salePriceGross\": \"\",\n \"factor\": \"\",\n \"margin\": \"\",\n \"vatTypeId\": \"\",\n \"packQuantity\": \"\",\n \"packProductId\": \"\",\n \"temporaryImageIds\": [\n \"\",\n \"\"\n ],\n \"defaultTemporaryImageId\": \"\",\n \"defaultImageId\": \"\",\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n }\n ],\n \"stockMinimums\": [\n {\n \"warehouseId\": \"\",\n \"minimumStock\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"minimumStock\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"barCode\": \"\",\n \"gtin\": \"\",\n \"reference\": \"\",\n \"description\": \"\",\n \"supplierDescription\": \"\",\n \"color\": \"\",\n \"rod\": \"\",\n \"bridge\": \"\",\n \"horizontalDiameter\": \"\",\n \"verticalDiameter\": \"\",\n \"usefulLifeDays\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"discontinued\": \"\",\n \"batch\": \"\",\n \"purchasePriceNet\": \"\",\n \"purchasePriceGross\": \"\",\n \"salePriceNet\": \"\",\n \"salePriceGross\": \"\",\n \"factor\": \"\",\n \"margin\": \"\",\n \"vatTypeId\": \"\",\n \"packQuantity\": \"\",\n \"packProductId\": \"\",\n \"temporaryImageIds\": [\n \"\",\n \"\"\n ],\n \"defaultTemporaryImageId\": \"\",\n \"defaultImageId\": \"\",\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n }\n ],\n \"stockMinimums\": [\n {\n \"warehouseId\": \"\",\n \"minimumStock\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"minimumStock\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bd8088eb-f8e4-490f-8922-80761c985b51", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"modelCode\": \"\",\n \"reference\": \"\",\n \"alias\": \"\",\n \"cabysCode\": \"\",\n \"externalId\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"blockType\": \"\",\n \"manufacturable\": \"\",\n \"inventoriable\": \"\",\n \"needsRawMaterial\": \"\",\n \"batchRequired\": \"\",\n \"priceEditable\": \"\",\n \"online\": \"\",\n \"fabricabilityByVariant\": \"\",\n \"material\": \"\",\n \"frameType\": \"\",\n \"gender\": \"\",\n \"usefulLifeDays\": \"\",\n \"currencyCode\": \"\",\n \"systemCurrencyCode\": \"\",\n \"lensIndex\": \"\",\n \"lensStrx\": \"\",\n \"lensMaterial\": \"\",\n \"lensShape\": \"\",\n \"onlineName\": \"\",\n \"shortDescription\": \"\",\n \"extendedDescription\": \"\",\n \"linkRewrite\": \"\",\n \"webStockManagementType\": \"\",\n \"webVisibilityType\": \"\",\n \"onlineChannelIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\",\n \"supplierId\": \"\",\n \"categoryId\": \"\",\n \"brandId\": \"\",\n \"groupId\": \"\",\n \"campaignId\": \"\",\n \"collectionId\": \"\",\n \"rangeId\": \"\",\n \"itemTypeId\": \"\",\n \"vatTypeId\": \"\",\n \"additionalCategoryIds\": [\n \"\",\n \"\"\n ],\n \"defaultVariantId\": \"\",\n \"caseProductId\": \"\",\n \"workOrderProductId\": \"\",\n \"temporaryImageIds\": [\n \"\",\n \"\"\n ],\n \"defaultTemporaryImageId\": \"\",\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n }\n ],\n \"variantCustomFieldIds\": [\n \"\",\n \"\"\n ],\n \"manufacturingFieldIds\": [\n \"\",\n \"\"\n ],\n \"variants\": [\n {\n \"id\": \"\",\n \"barCode\": \"\",\n \"gtin\": \"\",\n \"reference\": \"\",\n \"description\": \"\",\n \"supplierDescription\": \"\",\n \"color\": \"\",\n \"rod\": \"\",\n \"bridge\": \"\",\n \"horizontalDiameter\": \"\",\n \"verticalDiameter\": \"\",\n \"usefulLifeDays\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"discontinued\": \"\",\n \"batch\": \"\",\n \"purchasePriceNet\": \"\",\n \"purchasePriceGross\": \"\",\n \"salePriceNet\": \"\",\n \"salePriceGross\": \"\",\n \"factor\": \"\",\n \"margin\": \"\",\n \"vatTypeId\": \"\",\n \"packQuantity\": \"\",\n \"packProductId\": \"\",\n \"temporaryImageIds\": [\n \"\",\n \"\"\n ],\n \"defaultTemporaryImageId\": \"\",\n \"defaultImageId\": \"\",\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n }\n ],\n \"stockMinimums\": [\n {\n \"warehouseId\": \"\",\n \"minimumStock\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"minimumStock\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"barCode\": \"\",\n \"gtin\": \"\",\n \"reference\": \"\",\n \"description\": \"\",\n \"supplierDescription\": \"\",\n \"color\": \"\",\n \"rod\": \"\",\n \"bridge\": \"\",\n \"horizontalDiameter\": \"\",\n \"verticalDiameter\": \"\",\n \"usefulLifeDays\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"discontinued\": \"\",\n \"batch\": \"\",\n \"purchasePriceNet\": \"\",\n \"purchasePriceGross\": \"\",\n \"salePriceNet\": \"\",\n \"salePriceGross\": \"\",\n \"factor\": \"\",\n \"margin\": \"\",\n \"vatTypeId\": \"\",\n \"packQuantity\": \"\",\n \"packProductId\": \"\",\n \"temporaryImageIds\": [\n \"\",\n \"\"\n ],\n \"defaultTemporaryImageId\": \"\",\n \"defaultImageId\": \"\",\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n }\n ],\n \"stockMinimums\": [\n {\n \"warehouseId\": \"\",\n \"minimumStock\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"minimumStock\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d1d8e69d-c9c1-431d-a27d-901699f40cf1", "name": "Authenticated user is missing the `EDITAR_MODELOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"modelCode\": \"\",\n \"reference\": \"\",\n \"alias\": \"\",\n \"cabysCode\": \"\",\n \"externalId\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"blockType\": \"\",\n \"manufacturable\": \"\",\n \"inventoriable\": \"\",\n \"needsRawMaterial\": \"\",\n \"batchRequired\": \"\",\n \"priceEditable\": \"\",\n \"online\": \"\",\n \"fabricabilityByVariant\": \"\",\n \"material\": \"\",\n \"frameType\": \"\",\n \"gender\": \"\",\n \"usefulLifeDays\": \"\",\n \"currencyCode\": \"\",\n \"systemCurrencyCode\": \"\",\n \"lensIndex\": \"\",\n \"lensStrx\": \"\",\n \"lensMaterial\": \"\",\n \"lensShape\": \"\",\n \"onlineName\": \"\",\n \"shortDescription\": \"\",\n \"extendedDescription\": \"\",\n \"linkRewrite\": \"\",\n \"webStockManagementType\": \"\",\n \"webVisibilityType\": \"\",\n \"onlineChannelIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\",\n \"supplierId\": \"\",\n \"categoryId\": \"\",\n \"brandId\": \"\",\n \"groupId\": \"\",\n \"campaignId\": \"\",\n \"collectionId\": \"\",\n \"rangeId\": \"\",\n \"itemTypeId\": \"\",\n \"vatTypeId\": \"\",\n \"additionalCategoryIds\": [\n \"\",\n \"\"\n ],\n \"defaultVariantId\": \"\",\n \"caseProductId\": \"\",\n \"workOrderProductId\": \"\",\n \"temporaryImageIds\": [\n \"\",\n \"\"\n ],\n \"defaultTemporaryImageId\": \"\",\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n }\n ],\n \"variantCustomFieldIds\": [\n \"\",\n \"\"\n ],\n \"manufacturingFieldIds\": [\n \"\",\n \"\"\n ],\n \"variants\": [\n {\n \"id\": \"\",\n \"barCode\": \"\",\n \"gtin\": \"\",\n \"reference\": \"\",\n \"description\": \"\",\n \"supplierDescription\": \"\",\n \"color\": \"\",\n \"rod\": \"\",\n \"bridge\": \"\",\n \"horizontalDiameter\": \"\",\n \"verticalDiameter\": \"\",\n \"usefulLifeDays\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"discontinued\": \"\",\n \"batch\": \"\",\n \"purchasePriceNet\": \"\",\n \"purchasePriceGross\": \"\",\n \"salePriceNet\": \"\",\n \"salePriceGross\": \"\",\n \"factor\": \"\",\n \"margin\": \"\",\n \"vatTypeId\": \"\",\n \"packQuantity\": \"\",\n \"packProductId\": \"\",\n \"temporaryImageIds\": [\n \"\",\n \"\"\n ],\n \"defaultTemporaryImageId\": \"\",\n \"defaultImageId\": \"\",\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n }\n ],\n \"stockMinimums\": [\n {\n \"warehouseId\": \"\",\n \"minimumStock\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"minimumStock\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"barCode\": \"\",\n \"gtin\": \"\",\n \"reference\": \"\",\n \"description\": \"\",\n \"supplierDescription\": \"\",\n \"color\": \"\",\n \"rod\": \"\",\n \"bridge\": \"\",\n \"horizontalDiameter\": \"\",\n \"verticalDiameter\": \"\",\n \"usefulLifeDays\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"discontinued\": \"\",\n \"batch\": \"\",\n \"purchasePriceNet\": \"\",\n \"purchasePriceGross\": \"\",\n \"salePriceNet\": \"\",\n \"salePriceGross\": \"\",\n \"factor\": \"\",\n \"margin\": \"\",\n \"vatTypeId\": \"\",\n \"packQuantity\": \"\",\n \"packProductId\": \"\",\n \"temporaryImageIds\": [\n \"\",\n \"\"\n ],\n \"defaultTemporaryImageId\": \"\",\n \"defaultImageId\": \"\",\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n }\n ],\n \"stockMinimums\": [\n {\n \"warehouseId\": \"\",\n \"minimumStock\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"minimumStock\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8e5a85c8-777b-41a0-8d1a-7a3dbbc13958", "name": "Product not found", "originalRequest": { "url": { "path": [ "api", "v2", "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"modelCode\": \"\",\n \"reference\": \"\",\n \"alias\": \"\",\n \"cabysCode\": \"\",\n \"externalId\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"blockType\": \"\",\n \"manufacturable\": \"\",\n \"inventoriable\": \"\",\n \"needsRawMaterial\": \"\",\n \"batchRequired\": \"\",\n \"priceEditable\": \"\",\n \"online\": \"\",\n \"fabricabilityByVariant\": \"\",\n \"material\": \"\",\n \"frameType\": \"\",\n \"gender\": \"\",\n \"usefulLifeDays\": \"\",\n \"currencyCode\": \"\",\n \"systemCurrencyCode\": \"\",\n \"lensIndex\": \"\",\n \"lensStrx\": \"\",\n \"lensMaterial\": \"\",\n \"lensShape\": \"\",\n \"onlineName\": \"\",\n \"shortDescription\": \"\",\n \"extendedDescription\": \"\",\n \"linkRewrite\": \"\",\n \"webStockManagementType\": \"\",\n \"webVisibilityType\": \"\",\n \"onlineChannelIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\",\n \"supplierId\": \"\",\n \"categoryId\": \"\",\n \"brandId\": \"\",\n \"groupId\": \"\",\n \"campaignId\": \"\",\n \"collectionId\": \"\",\n \"rangeId\": \"\",\n \"itemTypeId\": \"\",\n \"vatTypeId\": \"\",\n \"additionalCategoryIds\": [\n \"\",\n \"\"\n ],\n \"defaultVariantId\": \"\",\n \"caseProductId\": \"\",\n \"workOrderProductId\": \"\",\n \"temporaryImageIds\": [\n \"\",\n \"\"\n ],\n \"defaultTemporaryImageId\": \"\",\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n }\n ],\n \"variantCustomFieldIds\": [\n \"\",\n \"\"\n ],\n \"manufacturingFieldIds\": [\n \"\",\n \"\"\n ],\n \"variants\": [\n {\n \"id\": \"\",\n \"barCode\": \"\",\n \"gtin\": \"\",\n \"reference\": \"\",\n \"description\": \"\",\n \"supplierDescription\": \"\",\n \"color\": \"\",\n \"rod\": \"\",\n \"bridge\": \"\",\n \"horizontalDiameter\": \"\",\n \"verticalDiameter\": \"\",\n \"usefulLifeDays\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"discontinued\": \"\",\n \"batch\": \"\",\n \"purchasePriceNet\": \"\",\n \"purchasePriceGross\": \"\",\n \"salePriceNet\": \"\",\n \"salePriceGross\": \"\",\n \"factor\": \"\",\n \"margin\": \"\",\n \"vatTypeId\": \"\",\n \"packQuantity\": \"\",\n \"packProductId\": \"\",\n \"temporaryImageIds\": [\n \"\",\n \"\"\n ],\n \"defaultTemporaryImageId\": \"\",\n \"defaultImageId\": \"\",\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n }\n ],\n \"stockMinimums\": [\n {\n \"warehouseId\": \"\",\n \"minimumStock\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"minimumStock\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"barCode\": \"\",\n \"gtin\": \"\",\n \"reference\": \"\",\n \"description\": \"\",\n \"supplierDescription\": \"\",\n \"color\": \"\",\n \"rod\": \"\",\n \"bridge\": \"\",\n \"horizontalDiameter\": \"\",\n \"verticalDiameter\": \"\",\n \"usefulLifeDays\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"discontinued\": \"\",\n \"batch\": \"\",\n \"purchasePriceNet\": \"\",\n \"purchasePriceGross\": \"\",\n \"salePriceNet\": \"\",\n \"salePriceGross\": \"\",\n \"factor\": \"\",\n \"margin\": \"\",\n \"vatTypeId\": \"\",\n \"packQuantity\": \"\",\n \"packProductId\": \"\",\n \"temporaryImageIds\": [\n \"\",\n \"\"\n ],\n \"defaultTemporaryImageId\": \"\",\n \"defaultImageId\": \"\",\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n }\n ],\n \"stockMinimums\": [\n {\n \"warehouseId\": \"\",\n \"minimumStock\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"minimumStock\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e2ecb9d8-ae4c-4847-a6e5-ccb110436971", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"modelCode\": \"\",\n \"reference\": \"\",\n \"alias\": \"\",\n \"cabysCode\": \"\",\n \"externalId\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"blockType\": \"\",\n \"manufacturable\": \"\",\n \"inventoriable\": \"\",\n \"needsRawMaterial\": \"\",\n \"batchRequired\": \"\",\n \"priceEditable\": \"\",\n \"online\": \"\",\n \"fabricabilityByVariant\": \"\",\n \"material\": \"\",\n \"frameType\": \"\",\n \"gender\": \"\",\n \"usefulLifeDays\": \"\",\n \"currencyCode\": \"\",\n \"systemCurrencyCode\": \"\",\n \"lensIndex\": \"\",\n \"lensStrx\": \"\",\n \"lensMaterial\": \"\",\n \"lensShape\": \"\",\n \"onlineName\": \"\",\n \"shortDescription\": \"\",\n \"extendedDescription\": \"\",\n \"linkRewrite\": \"\",\n \"webStockManagementType\": \"\",\n \"webVisibilityType\": \"\",\n \"onlineChannelIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\",\n \"supplierId\": \"\",\n \"categoryId\": \"\",\n \"brandId\": \"\",\n \"groupId\": \"\",\n \"campaignId\": \"\",\n \"collectionId\": \"\",\n \"rangeId\": \"\",\n \"itemTypeId\": \"\",\n \"vatTypeId\": \"\",\n \"additionalCategoryIds\": [\n \"\",\n \"\"\n ],\n \"defaultVariantId\": \"\",\n \"caseProductId\": \"\",\n \"workOrderProductId\": \"\",\n \"temporaryImageIds\": [\n \"\",\n \"\"\n ],\n \"defaultTemporaryImageId\": \"\",\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n }\n ],\n \"variantCustomFieldIds\": [\n \"\",\n \"\"\n ],\n \"manufacturingFieldIds\": [\n \"\",\n \"\"\n ],\n \"variants\": [\n {\n \"id\": \"\",\n \"barCode\": \"\",\n \"gtin\": \"\",\n \"reference\": \"\",\n \"description\": \"\",\n \"supplierDescription\": \"\",\n \"color\": \"\",\n \"rod\": \"\",\n \"bridge\": \"\",\n \"horizontalDiameter\": \"\",\n \"verticalDiameter\": \"\",\n \"usefulLifeDays\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"discontinued\": \"\",\n \"batch\": \"\",\n \"purchasePriceNet\": \"\",\n \"purchasePriceGross\": \"\",\n \"salePriceNet\": \"\",\n \"salePriceGross\": \"\",\n \"factor\": \"\",\n \"margin\": \"\",\n \"vatTypeId\": \"\",\n \"packQuantity\": \"\",\n \"packProductId\": \"\",\n \"temporaryImageIds\": [\n \"\",\n \"\"\n ],\n \"defaultTemporaryImageId\": \"\",\n \"defaultImageId\": \"\",\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n }\n ],\n \"stockMinimums\": [\n {\n \"warehouseId\": \"\",\n \"minimumStock\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"minimumStock\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"barCode\": \"\",\n \"gtin\": \"\",\n \"reference\": \"\",\n \"description\": \"\",\n \"supplierDescription\": \"\",\n \"color\": \"\",\n \"rod\": \"\",\n \"bridge\": \"\",\n \"horizontalDiameter\": \"\",\n \"verticalDiameter\": \"\",\n \"usefulLifeDays\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"discontinued\": \"\",\n \"batch\": \"\",\n \"purchasePriceNet\": \"\",\n \"purchasePriceGross\": \"\",\n \"salePriceNet\": \"\",\n \"salePriceGross\": \"\",\n \"factor\": \"\",\n \"margin\": \"\",\n \"vatTypeId\": \"\",\n \"packQuantity\": \"\",\n \"packProductId\": \"\",\n \"temporaryImageIds\": [\n \"\",\n \"\"\n ],\n \"defaultTemporaryImageId\": \"\",\n \"defaultImageId\": \"\",\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n }\n ],\n \"stockMinimums\": [\n {\n \"warehouseId\": \"\",\n \"minimumStock\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"minimumStock\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0e53ce1c-a043-46c9-9ef2-11bb4ab679f9", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"modelCode\": \"\",\n \"reference\": \"\",\n \"alias\": \"\",\n \"cabysCode\": \"\",\n \"externalId\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"blockType\": \"\",\n \"manufacturable\": \"\",\n \"inventoriable\": \"\",\n \"needsRawMaterial\": \"\",\n \"batchRequired\": \"\",\n \"priceEditable\": \"\",\n \"online\": \"\",\n \"fabricabilityByVariant\": \"\",\n \"material\": \"\",\n \"frameType\": \"\",\n \"gender\": \"\",\n \"usefulLifeDays\": \"\",\n \"currencyCode\": \"\",\n \"systemCurrencyCode\": \"\",\n \"lensIndex\": \"\",\n \"lensStrx\": \"\",\n \"lensMaterial\": \"\",\n \"lensShape\": \"\",\n \"onlineName\": \"\",\n \"shortDescription\": \"\",\n \"extendedDescription\": \"\",\n \"linkRewrite\": \"\",\n \"webStockManagementType\": \"\",\n \"webVisibilityType\": \"\",\n \"onlineChannelIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\",\n \"supplierId\": \"\",\n \"categoryId\": \"\",\n \"brandId\": \"\",\n \"groupId\": \"\",\n \"campaignId\": \"\",\n \"collectionId\": \"\",\n \"rangeId\": \"\",\n \"itemTypeId\": \"\",\n \"vatTypeId\": \"\",\n \"additionalCategoryIds\": [\n \"\",\n \"\"\n ],\n \"defaultVariantId\": \"\",\n \"caseProductId\": \"\",\n \"workOrderProductId\": \"\",\n \"temporaryImageIds\": [\n \"\",\n \"\"\n ],\n \"defaultTemporaryImageId\": \"\",\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n }\n ],\n \"variantCustomFieldIds\": [\n \"\",\n \"\"\n ],\n \"manufacturingFieldIds\": [\n \"\",\n \"\"\n ],\n \"variants\": [\n {\n \"id\": \"\",\n \"barCode\": \"\",\n \"gtin\": \"\",\n \"reference\": \"\",\n \"description\": \"\",\n \"supplierDescription\": \"\",\n \"color\": \"\",\n \"rod\": \"\",\n \"bridge\": \"\",\n \"horizontalDiameter\": \"\",\n \"verticalDiameter\": \"\",\n \"usefulLifeDays\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"discontinued\": \"\",\n \"batch\": \"\",\n \"purchasePriceNet\": \"\",\n \"purchasePriceGross\": \"\",\n \"salePriceNet\": \"\",\n \"salePriceGross\": \"\",\n \"factor\": \"\",\n \"margin\": \"\",\n \"vatTypeId\": \"\",\n \"packQuantity\": \"\",\n \"packProductId\": \"\",\n \"temporaryImageIds\": [\n \"\",\n \"\"\n ],\n \"defaultTemporaryImageId\": \"\",\n \"defaultImageId\": \"\",\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n }\n ],\n \"stockMinimums\": [\n {\n \"warehouseId\": \"\",\n \"minimumStock\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"minimumStock\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"barCode\": \"\",\n \"gtin\": \"\",\n \"reference\": \"\",\n \"description\": \"\",\n \"supplierDescription\": \"\",\n \"color\": \"\",\n \"rod\": \"\",\n \"bridge\": \"\",\n \"horizontalDiameter\": \"\",\n \"verticalDiameter\": \"\",\n \"usefulLifeDays\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"discontinued\": \"\",\n \"batch\": \"\",\n \"purchasePriceNet\": \"\",\n \"purchasePriceGross\": \"\",\n \"salePriceNet\": \"\",\n \"salePriceGross\": \"\",\n \"factor\": \"\",\n \"margin\": \"\",\n \"vatTypeId\": \"\",\n \"packQuantity\": \"\",\n \"packProductId\": \"\",\n \"temporaryImageIds\": [\n \"\",\n \"\"\n ],\n \"defaultTemporaryImageId\": \"\",\n \"defaultImageId\": \"\",\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n }\n ],\n \"stockMinimums\": [\n {\n \"warehouseId\": \"\",\n \"minimumStock\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"minimumStock\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "129da46b-24c2-4dc0-9370-0931e562eb91", "name": "Delete product", "request": { "name": "Delete product", "description": { "content": "Deletes a product and all of its variants (cascade). Send the `If-Match` header with the current ETag for optimistic concurrency control. Products referenced by sales documents cannot be deleted and return `409 Conflict`.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Product ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "8d18a873-c0d4-43a6-b638-a8a824b1fa3e", "name": "Product deleted", "originalRequest": { "url": { "path": [ "api", "v2", "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "09bed9bd-47fa-486c-9fef-0d0c86efcf1e", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cca3a80a-5b89-44e9-b295-b90adb91f183", "name": "Authenticated user is missing the `BORRAR_MODELOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "192e1f2b-5965-400b-9396-c699c4b2fe3b", "name": "Product not found", "originalRequest": { "url": { "path": [ "api", "v2", "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5759d5e7-0639-46c5-89cf-f99101f2916c", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued. Also returned when the product is referenced by sales documents.", "originalRequest": { "url": { "path": [ "api", "v2", "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d30b9fee-d975-40a3-a6c0-97931e06c934", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "22689105-78ee-4b64-beb9-00856ee56174", "name": "Merge-patch product", "request": { "name": "Merge-patch product", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control. For variant collections, use the variant `id` to update existing rows; the merge keeps any field not mentioned in the patch.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Product ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "983d28a9-9203-4cda-a73d-e87d618f280f", "name": "Product patched", "originalRequest": { "url": { "path": [ "api", "v2", "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"modelCode\": \"\",\n \"reference\": \"\",\n \"alias\": \"\",\n \"cabysCode\": \"\",\n \"externalId\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"blockType\": \"\",\n \"manufacturable\": \"\",\n \"inventoriable\": \"\",\n \"needsRawMaterial\": \"\",\n \"batchRequired\": \"\",\n \"priceEditable\": \"\",\n \"online\": \"\",\n \"fabricabilityByVariant\": \"\",\n \"material\": \"\",\n \"frameType\": \"\",\n \"gender\": \"\",\n \"usefulLifeDays\": \"\",\n \"currencyCode\": \"\",\n \"systemCurrencyCode\": \"\",\n \"lensIndex\": \"\",\n \"lensStrx\": \"\",\n \"lensMaterial\": \"\",\n \"lensShape\": \"\",\n \"onlineName\": \"\",\n \"shortDescription\": \"\",\n \"extendedDescription\": \"\",\n \"linkRewrite\": \"\",\n \"webStockManagementType\": \"\",\n \"webVisibilityType\": \"\",\n \"onlineChannelIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"supplierId\": \"\",\n \"supplierName\": \"\",\n \"categoryId\": \"\",\n \"categoryName\": \"\",\n \"brandId\": \"\",\n \"brandName\": \"\",\n \"groupId\": \"\",\n \"groupName\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"collectionId\": \"\",\n \"collectionName\": \"\",\n \"rangeId\": \"\",\n \"rangeName\": \"\",\n \"itemTypeId\": \"\",\n \"itemTypeName\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatRate\": \"\",\n \"categories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"defaultVariantId\": \"\",\n \"defaultImageId\": \"\",\n \"caseProductId\": \"\",\n \"caseProductName\": \"\",\n \"workOrderProductId\": \"\",\n \"workOrderProductName\": \"\",\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"valueType\": \"\",\n \"value\": \"\",\n \"optionId\": \"\",\n \"optionLabel\": \"\",\n \"optionHex\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"valueType\": \"\",\n \"value\": \"\",\n \"optionId\": \"\",\n \"optionLabel\": \"\",\n \"optionHex\": \"\"\n }\n ],\n \"variantCustomFieldIds\": [\n \"\",\n \"\"\n ],\n \"manufacturingFieldIds\": [\n \"\",\n \"\"\n ],\n \"variants\": [\n {\n \"id\": \"\",\n \"version\": \"\",\n \"barCode\": \"\",\n \"gtin\": \"\",\n \"reference\": \"\",\n \"description\": \"\",\n \"supplierDescription\": \"\",\n \"color\": \"\",\n \"rod\": \"\",\n \"bridge\": \"\",\n \"horizontalDiameter\": \"\",\n \"verticalDiameter\": \"\",\n \"usefulLifeDays\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"discontinued\": \"\",\n \"batch\": \"\",\n \"inventoriable\": \"\",\n \"priceEditable\": \"\",\n \"purchasePriceNet\": \"\",\n \"purchasePriceGross\": \"\",\n \"salePriceNet\": \"\",\n \"salePriceGross\": \"\",\n \"factor\": \"\",\n \"margin\": \"\",\n \"vatTypeId\": \"\",\n \"vatRate\": \"\",\n \"purchasePriceSystem\": \"\",\n \"salePriceSystem\": \"\",\n \"salePriceGrossSystem\": \"\",\n \"exchangeRate\": \"\",\n \"packQuantity\": \"\",\n \"packProductId\": \"\",\n \"defaultImageId\": \"\",\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"valueType\": \"\",\n \"value\": \"\",\n \"optionId\": \"\",\n \"optionLabel\": \"\",\n \"optionHex\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"valueType\": \"\",\n \"value\": \"\",\n \"optionId\": \"\",\n \"optionLabel\": \"\",\n \"optionHex\": \"\"\n }\n ],\n \"stockLevels\": [\n {\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"currentQuantity\": \"\",\n \"reservedQuantity\": \"\",\n \"minimumStock\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"currentQuantity\": \"\",\n \"reservedQuantity\": \"\",\n \"minimumStock\": \"\"\n }\n ],\n \"supplierPrices\": [\n {\n \"id\": \"\",\n \"supplierId\": \"\",\n \"supplierName\": \"\",\n \"reference\": \"\",\n \"price\": \"\",\n \"lastPurchaseDate\": \"\"\n },\n {\n \"id\": \"\",\n \"supplierId\": \"\",\n \"supplierName\": \"\",\n \"reference\": \"\",\n \"price\": \"\",\n \"lastPurchaseDate\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n },\n {\n \"id\": \"\",\n \"version\": \"\",\n \"barCode\": \"\",\n \"gtin\": \"\",\n \"reference\": \"\",\n \"description\": \"\",\n \"supplierDescription\": \"\",\n \"color\": \"\",\n \"rod\": \"\",\n \"bridge\": \"\",\n \"horizontalDiameter\": \"\",\n \"verticalDiameter\": \"\",\n \"usefulLifeDays\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"discontinued\": \"\",\n \"batch\": \"\",\n \"inventoriable\": \"\",\n \"priceEditable\": \"\",\n \"purchasePriceNet\": \"\",\n \"purchasePriceGross\": \"\",\n \"salePriceNet\": \"\",\n \"salePriceGross\": \"\",\n \"factor\": \"\",\n \"margin\": \"\",\n \"vatTypeId\": \"\",\n \"vatRate\": \"\",\n \"purchasePriceSystem\": \"\",\n \"salePriceSystem\": \"\",\n \"salePriceGrossSystem\": \"\",\n \"exchangeRate\": \"\",\n \"packQuantity\": \"\",\n \"packProductId\": \"\",\n \"defaultImageId\": \"\",\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"valueType\": \"\",\n \"value\": \"\",\n \"optionId\": \"\",\n \"optionLabel\": \"\",\n \"optionHex\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"valueType\": \"\",\n \"value\": \"\",\n \"optionId\": \"\",\n \"optionLabel\": \"\",\n \"optionHex\": \"\"\n }\n ],\n \"stockLevels\": [\n {\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"currentQuantity\": \"\",\n \"reservedQuantity\": \"\",\n \"minimumStock\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"currentQuantity\": \"\",\n \"reservedQuantity\": \"\",\n \"minimumStock\": \"\"\n }\n ],\n \"supplierPrices\": [\n {\n \"id\": \"\",\n \"supplierId\": \"\",\n \"supplierName\": \"\",\n \"reference\": \"\",\n \"price\": \"\",\n \"lastPurchaseDate\": \"\"\n },\n {\n \"id\": \"\",\n \"supplierId\": \"\",\n \"supplierName\": \"\",\n \"reference\": \"\",\n \"price\": \"\",\n \"lastPurchaseDate\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"images\": [\n {\n \"id\": \"\",\n \"url\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"url\": \"\",\n \"name\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d4211b22-0d45-4c24-a499-000e9dd149ae", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details. Also returned for malformed merge-patch payloads.", "originalRequest": { "url": { "path": [ "api", "v2", "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1541613a-445c-4b84-bea4-0157a2d2178b", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "45fa1bcc-0e77-451f-b800-c84ae43381e2", "name": "Authenticated user is missing the `EDITAR_MODELOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7685784f-ab5e-431d-8ef4-53652325c609", "name": "Product not found", "originalRequest": { "url": { "path": [ "api", "v2", "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cb1db329-a5da-4c40-8250-4b37fd7c2888", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bb55e91b-6524-4954-bb56-3495efaf696e", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "3d62c2f0-6eb2-43e9-a79b-fcd9cf16a1b9", "name": "List products", "request": { "name": "List products", "description": { "content": "Returns a paginated list of products with envelope `{data, totalCount, skip, limit, hasMore}`. The listing does NOT include variants ÔÇö fetch a single product with `GET /{id}` to get the full graph. Default sort is `lastModifiedAt:desc`. Limit is capped at 200; skip is clamped to >= 0.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "f60c3937-9f00-4c46-8ac1-88724853bee4", "name": "Page of products", "originalRequest": { "url": { "path": [ "api", "v2", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "112842a6-32c8-4549-a1e3-2bf97b66fc63", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3eef1a0b-2f6c-48d5-baf8-9db0a2c006b1", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7ac92f8f-048c-4aa6-841f-79fc13a6b0a4", "name": "Authenticated user is missing the `VER_MODELOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "10f93991-4c2b-479b-8147-aff40b50973d", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "324aa9c3-d06d-4304-919f-7fe54dea5993", "name": "Create product", "request": { "name": "Create product", "description": { "content": "Creates a new product with at least one variant. Business logic (FK resolution, supplier-price denormalisation, stock initialisation, default-variant linkage) runs in the legacy WAR via the internal commands gateway. Returns the full graph of the created product with all assigned IDs.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"modelCode\": \"\",\n \"reference\": \"\",\n \"alias\": \"\",\n \"cabysCode\": \"\",\n \"externalId\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"blockType\": \"\",\n \"manufacturable\": \"\",\n \"inventoriable\": \"\",\n \"needsRawMaterial\": \"\",\n \"batchRequired\": \"\",\n \"priceEditable\": \"\",\n \"online\": \"\",\n \"fabricabilityByVariant\": \"\",\n \"material\": \"\",\n \"frameType\": \"\",\n \"gender\": \"\",\n \"usefulLifeDays\": \"\",\n \"currencyCode\": \"\",\n \"systemCurrencyCode\": \"\",\n \"lensIndex\": \"\",\n \"lensStrx\": \"\",\n \"lensMaterial\": \"\",\n \"lensShape\": \"\",\n \"onlineName\": \"\",\n \"shortDescription\": \"\",\n \"extendedDescription\": \"\",\n \"linkRewrite\": \"\",\n \"webStockManagementType\": \"\",\n \"webVisibilityType\": \"\",\n \"onlineChannelIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\",\n \"supplierId\": \"\",\n \"categoryId\": \"\",\n \"brandId\": \"\",\n \"groupId\": \"\",\n \"campaignId\": \"\",\n \"collectionId\": \"\",\n \"rangeId\": \"\",\n \"itemTypeId\": \"\",\n \"vatTypeId\": \"\",\n \"additionalCategoryIds\": [\n \"\",\n \"\"\n ],\n \"defaultVariantId\": \"\",\n \"caseProductId\": \"\",\n \"workOrderProductId\": \"\",\n \"temporaryImageIds\": [\n \"\",\n \"\"\n ],\n \"defaultTemporaryImageId\": \"\",\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n }\n ],\n \"variantCustomFieldIds\": [\n \"\",\n \"\"\n ],\n \"manufacturingFieldIds\": [\n \"\",\n \"\"\n ],\n \"variants\": [\n {\n \"id\": \"\",\n \"barCode\": \"\",\n \"gtin\": \"\",\n \"reference\": \"\",\n \"description\": \"\",\n \"supplierDescription\": \"\",\n \"color\": \"\",\n \"rod\": \"\",\n \"bridge\": \"\",\n \"horizontalDiameter\": \"\",\n \"verticalDiameter\": \"\",\n \"usefulLifeDays\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"discontinued\": \"\",\n \"batch\": \"\",\n \"purchasePriceNet\": \"\",\n \"purchasePriceGross\": \"\",\n \"salePriceNet\": \"\",\n \"salePriceGross\": \"\",\n \"factor\": \"\",\n \"margin\": \"\",\n \"vatTypeId\": \"\",\n \"packQuantity\": \"\",\n \"packProductId\": \"\",\n \"temporaryImageIds\": [\n \"\",\n \"\"\n ],\n \"defaultTemporaryImageId\": \"\",\n \"defaultImageId\": \"\",\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n }\n ],\n \"stockMinimums\": [\n {\n \"warehouseId\": \"\",\n \"minimumStock\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"minimumStock\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"barCode\": \"\",\n \"gtin\": \"\",\n \"reference\": \"\",\n \"description\": \"\",\n \"supplierDescription\": \"\",\n \"color\": \"\",\n \"rod\": \"\",\n \"bridge\": \"\",\n \"horizontalDiameter\": \"\",\n \"verticalDiameter\": \"\",\n \"usefulLifeDays\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"discontinued\": \"\",\n \"batch\": \"\",\n \"purchasePriceNet\": \"\",\n \"purchasePriceGross\": \"\",\n \"salePriceNet\": \"\",\n \"salePriceGross\": \"\",\n \"factor\": \"\",\n \"margin\": \"\",\n \"vatTypeId\": \"\",\n \"packQuantity\": \"\",\n \"packProductId\": \"\",\n \"temporaryImageIds\": [\n \"\",\n \"\"\n ],\n \"defaultTemporaryImageId\": \"\",\n \"defaultImageId\": \"\",\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n }\n ],\n \"stockMinimums\": [\n {\n \"warehouseId\": \"\",\n \"minimumStock\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"minimumStock\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "38dc2852-29b5-45a6-97f0-1895f59a2041", "name": "Product created", "originalRequest": { "url": { "path": [ "api", "v2", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"modelCode\": \"\",\n \"reference\": \"\",\n \"alias\": \"\",\n \"cabysCode\": \"\",\n \"externalId\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"blockType\": \"\",\n \"manufacturable\": \"\",\n \"inventoriable\": \"\",\n \"needsRawMaterial\": \"\",\n \"batchRequired\": \"\",\n \"priceEditable\": \"\",\n \"online\": \"\",\n \"fabricabilityByVariant\": \"\",\n \"material\": \"\",\n \"frameType\": \"\",\n \"gender\": \"\",\n \"usefulLifeDays\": \"\",\n \"currencyCode\": \"\",\n \"systemCurrencyCode\": \"\",\n \"lensIndex\": \"\",\n \"lensStrx\": \"\",\n \"lensMaterial\": \"\",\n \"lensShape\": \"\",\n \"onlineName\": \"\",\n \"shortDescription\": \"\",\n \"extendedDescription\": \"\",\n \"linkRewrite\": \"\",\n \"webStockManagementType\": \"\",\n \"webVisibilityType\": \"\",\n \"onlineChannelIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\",\n \"supplierId\": \"\",\n \"categoryId\": \"\",\n \"brandId\": \"\",\n \"groupId\": \"\",\n \"campaignId\": \"\",\n \"collectionId\": \"\",\n \"rangeId\": \"\",\n \"itemTypeId\": \"\",\n \"vatTypeId\": \"\",\n \"additionalCategoryIds\": [\n \"\",\n \"\"\n ],\n \"defaultVariantId\": \"\",\n \"caseProductId\": \"\",\n \"workOrderProductId\": \"\",\n \"temporaryImageIds\": [\n \"\",\n \"\"\n ],\n \"defaultTemporaryImageId\": \"\",\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n }\n ],\n \"variantCustomFieldIds\": [\n \"\",\n \"\"\n ],\n \"manufacturingFieldIds\": [\n \"\",\n \"\"\n ],\n \"variants\": [\n {\n \"id\": \"\",\n \"barCode\": \"\",\n \"gtin\": \"\",\n \"reference\": \"\",\n \"description\": \"\",\n \"supplierDescription\": \"\",\n \"color\": \"\",\n \"rod\": \"\",\n \"bridge\": \"\",\n \"horizontalDiameter\": \"\",\n \"verticalDiameter\": \"\",\n \"usefulLifeDays\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"discontinued\": \"\",\n \"batch\": \"\",\n \"purchasePriceNet\": \"\",\n \"purchasePriceGross\": \"\",\n \"salePriceNet\": \"\",\n \"salePriceGross\": \"\",\n \"factor\": \"\",\n \"margin\": \"\",\n \"vatTypeId\": \"\",\n \"packQuantity\": \"\",\n \"packProductId\": \"\",\n \"temporaryImageIds\": [\n \"\",\n \"\"\n ],\n \"defaultTemporaryImageId\": \"\",\n \"defaultImageId\": \"\",\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n }\n ],\n \"stockMinimums\": [\n {\n \"warehouseId\": \"\",\n \"minimumStock\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"minimumStock\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"barCode\": \"\",\n \"gtin\": \"\",\n \"reference\": \"\",\n \"description\": \"\",\n \"supplierDescription\": \"\",\n \"color\": \"\",\n \"rod\": \"\",\n \"bridge\": \"\",\n \"horizontalDiameter\": \"\",\n \"verticalDiameter\": \"\",\n \"usefulLifeDays\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"discontinued\": \"\",\n \"batch\": \"\",\n \"purchasePriceNet\": \"\",\n \"purchasePriceGross\": \"\",\n \"salePriceNet\": \"\",\n \"salePriceGross\": \"\",\n \"factor\": \"\",\n \"margin\": \"\",\n \"vatTypeId\": \"\",\n \"packQuantity\": \"\",\n \"packProductId\": \"\",\n \"temporaryImageIds\": [\n \"\",\n \"\"\n ],\n \"defaultTemporaryImageId\": \"\",\n \"defaultImageId\": \"\",\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n }\n ],\n \"stockMinimums\": [\n {\n \"warehouseId\": \"\",\n \"minimumStock\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"minimumStock\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"modelCode\": \"\",\n \"reference\": \"\",\n \"alias\": \"\",\n \"cabysCode\": \"\",\n \"externalId\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"blockType\": \"\",\n \"manufacturable\": \"\",\n \"inventoriable\": \"\",\n \"needsRawMaterial\": \"\",\n \"batchRequired\": \"\",\n \"priceEditable\": \"\",\n \"online\": \"\",\n \"fabricabilityByVariant\": \"\",\n \"material\": \"\",\n \"frameType\": \"\",\n \"gender\": \"\",\n \"usefulLifeDays\": \"\",\n \"currencyCode\": \"\",\n \"systemCurrencyCode\": \"\",\n \"lensIndex\": \"\",\n \"lensStrx\": \"\",\n \"lensMaterial\": \"\",\n \"lensShape\": \"\",\n \"onlineName\": \"\",\n \"shortDescription\": \"\",\n \"extendedDescription\": \"\",\n \"linkRewrite\": \"\",\n \"webStockManagementType\": \"\",\n \"webVisibilityType\": \"\",\n \"onlineChannelIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"supplierId\": \"\",\n \"supplierName\": \"\",\n \"categoryId\": \"\",\n \"categoryName\": \"\",\n \"brandId\": \"\",\n \"brandName\": \"\",\n \"groupId\": \"\",\n \"groupName\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"collectionId\": \"\",\n \"collectionName\": \"\",\n \"rangeId\": \"\",\n \"rangeName\": \"\",\n \"itemTypeId\": \"\",\n \"itemTypeName\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatRate\": \"\",\n \"categories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"defaultVariantId\": \"\",\n \"defaultImageId\": \"\",\n \"caseProductId\": \"\",\n \"caseProductName\": \"\",\n \"workOrderProductId\": \"\",\n \"workOrderProductName\": \"\",\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"valueType\": \"\",\n \"value\": \"\",\n \"optionId\": \"\",\n \"optionLabel\": \"\",\n \"optionHex\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"valueType\": \"\",\n \"value\": \"\",\n \"optionId\": \"\",\n \"optionLabel\": \"\",\n \"optionHex\": \"\"\n }\n ],\n \"variantCustomFieldIds\": [\n \"\",\n \"\"\n ],\n \"manufacturingFieldIds\": [\n \"\",\n \"\"\n ],\n \"variants\": [\n {\n \"id\": \"\",\n \"version\": \"\",\n \"barCode\": \"\",\n \"gtin\": \"\",\n \"reference\": \"\",\n \"description\": \"\",\n \"supplierDescription\": \"\",\n \"color\": \"\",\n \"rod\": \"\",\n \"bridge\": \"\",\n \"horizontalDiameter\": \"\",\n \"verticalDiameter\": \"\",\n \"usefulLifeDays\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"discontinued\": \"\",\n \"batch\": \"\",\n \"inventoriable\": \"\",\n \"priceEditable\": \"\",\n \"purchasePriceNet\": \"\",\n \"purchasePriceGross\": \"\",\n \"salePriceNet\": \"\",\n \"salePriceGross\": \"\",\n \"factor\": \"\",\n \"margin\": \"\",\n \"vatTypeId\": \"\",\n \"vatRate\": \"\",\n \"purchasePriceSystem\": \"\",\n \"salePriceSystem\": \"\",\n \"salePriceGrossSystem\": \"\",\n \"exchangeRate\": \"\",\n \"packQuantity\": \"\",\n \"packProductId\": \"\",\n \"defaultImageId\": \"\",\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"valueType\": \"\",\n \"value\": \"\",\n \"optionId\": \"\",\n \"optionLabel\": \"\",\n \"optionHex\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"valueType\": \"\",\n \"value\": \"\",\n \"optionId\": \"\",\n \"optionLabel\": \"\",\n \"optionHex\": \"\"\n }\n ],\n \"stockLevels\": [\n {\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"currentQuantity\": \"\",\n \"reservedQuantity\": \"\",\n \"minimumStock\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"currentQuantity\": \"\",\n \"reservedQuantity\": \"\",\n \"minimumStock\": \"\"\n }\n ],\n \"supplierPrices\": [\n {\n \"id\": \"\",\n \"supplierId\": \"\",\n \"supplierName\": \"\",\n \"reference\": \"\",\n \"price\": \"\",\n \"lastPurchaseDate\": \"\"\n },\n {\n \"id\": \"\",\n \"supplierId\": \"\",\n \"supplierName\": \"\",\n \"reference\": \"\",\n \"price\": \"\",\n \"lastPurchaseDate\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n },\n {\n \"id\": \"\",\n \"version\": \"\",\n \"barCode\": \"\",\n \"gtin\": \"\",\n \"reference\": \"\",\n \"description\": \"\",\n \"supplierDescription\": \"\",\n \"color\": \"\",\n \"rod\": \"\",\n \"bridge\": \"\",\n \"horizontalDiameter\": \"\",\n \"verticalDiameter\": \"\",\n \"usefulLifeDays\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"discontinued\": \"\",\n \"batch\": \"\",\n \"inventoriable\": \"\",\n \"priceEditable\": \"\",\n \"purchasePriceNet\": \"\",\n \"purchasePriceGross\": \"\",\n \"salePriceNet\": \"\",\n \"salePriceGross\": \"\",\n \"factor\": \"\",\n \"margin\": \"\",\n \"vatTypeId\": \"\",\n \"vatRate\": \"\",\n \"purchasePriceSystem\": \"\",\n \"salePriceSystem\": \"\",\n \"salePriceGrossSystem\": \"\",\n \"exchangeRate\": \"\",\n \"packQuantity\": \"\",\n \"packProductId\": \"\",\n \"defaultImageId\": \"\",\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"valueType\": \"\",\n \"value\": \"\",\n \"optionId\": \"\",\n \"optionLabel\": \"\",\n \"optionHex\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"valueType\": \"\",\n \"value\": \"\",\n \"optionId\": \"\",\n \"optionLabel\": \"\",\n \"optionHex\": \"\"\n }\n ],\n \"stockLevels\": [\n {\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"currentQuantity\": \"\",\n \"reservedQuantity\": \"\",\n \"minimumStock\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"currentQuantity\": \"\",\n \"reservedQuantity\": \"\",\n \"minimumStock\": \"\"\n }\n ],\n \"supplierPrices\": [\n {\n \"id\": \"\",\n \"supplierId\": \"\",\n \"supplierName\": \"\",\n \"reference\": \"\",\n \"price\": \"\",\n \"lastPurchaseDate\": \"\"\n },\n {\n \"id\": \"\",\n \"supplierId\": \"\",\n \"supplierName\": \"\",\n \"reference\": \"\",\n \"price\": \"\",\n \"lastPurchaseDate\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"images\": [\n {\n \"id\": \"\",\n \"url\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"url\": \"\",\n \"name\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5e37da67-5c39-411a-8fbf-004fdbd4df6b", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"modelCode\": \"\",\n \"reference\": \"\",\n \"alias\": \"\",\n \"cabysCode\": \"\",\n \"externalId\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"blockType\": \"\",\n \"manufacturable\": \"\",\n \"inventoriable\": \"\",\n \"needsRawMaterial\": \"\",\n \"batchRequired\": \"\",\n \"priceEditable\": \"\",\n \"online\": \"\",\n \"fabricabilityByVariant\": \"\",\n \"material\": \"\",\n \"frameType\": \"\",\n \"gender\": \"\",\n \"usefulLifeDays\": \"\",\n \"currencyCode\": \"\",\n \"systemCurrencyCode\": \"\",\n \"lensIndex\": \"\",\n \"lensStrx\": \"\",\n \"lensMaterial\": \"\",\n \"lensShape\": \"\",\n \"onlineName\": \"\",\n \"shortDescription\": \"\",\n \"extendedDescription\": \"\",\n \"linkRewrite\": \"\",\n \"webStockManagementType\": \"\",\n \"webVisibilityType\": \"\",\n \"onlineChannelIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\",\n \"supplierId\": \"\",\n \"categoryId\": \"\",\n \"brandId\": \"\",\n \"groupId\": \"\",\n \"campaignId\": \"\",\n \"collectionId\": \"\",\n \"rangeId\": \"\",\n \"itemTypeId\": \"\",\n \"vatTypeId\": \"\",\n \"additionalCategoryIds\": [\n \"\",\n \"\"\n ],\n \"defaultVariantId\": \"\",\n \"caseProductId\": \"\",\n \"workOrderProductId\": \"\",\n \"temporaryImageIds\": [\n \"\",\n \"\"\n ],\n \"defaultTemporaryImageId\": \"\",\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n }\n ],\n \"variantCustomFieldIds\": [\n \"\",\n \"\"\n ],\n \"manufacturingFieldIds\": [\n \"\",\n \"\"\n ],\n \"variants\": [\n {\n \"id\": \"\",\n \"barCode\": \"\",\n \"gtin\": \"\",\n \"reference\": \"\",\n \"description\": \"\",\n \"supplierDescription\": \"\",\n \"color\": \"\",\n \"rod\": \"\",\n \"bridge\": \"\",\n \"horizontalDiameter\": \"\",\n \"verticalDiameter\": \"\",\n \"usefulLifeDays\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"discontinued\": \"\",\n \"batch\": \"\",\n \"purchasePriceNet\": \"\",\n \"purchasePriceGross\": \"\",\n \"salePriceNet\": \"\",\n \"salePriceGross\": \"\",\n \"factor\": \"\",\n \"margin\": \"\",\n \"vatTypeId\": \"\",\n \"packQuantity\": \"\",\n \"packProductId\": \"\",\n \"temporaryImageIds\": [\n \"\",\n \"\"\n ],\n \"defaultTemporaryImageId\": \"\",\n \"defaultImageId\": \"\",\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n }\n ],\n \"stockMinimums\": [\n {\n \"warehouseId\": \"\",\n \"minimumStock\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"minimumStock\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"barCode\": \"\",\n \"gtin\": \"\",\n \"reference\": \"\",\n \"description\": \"\",\n \"supplierDescription\": \"\",\n \"color\": \"\",\n \"rod\": \"\",\n \"bridge\": \"\",\n \"horizontalDiameter\": \"\",\n \"verticalDiameter\": \"\",\n \"usefulLifeDays\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"discontinued\": \"\",\n \"batch\": \"\",\n \"purchasePriceNet\": \"\",\n \"purchasePriceGross\": \"\",\n \"salePriceNet\": \"\",\n \"salePriceGross\": \"\",\n \"factor\": \"\",\n \"margin\": \"\",\n \"vatTypeId\": \"\",\n \"packQuantity\": \"\",\n \"packProductId\": \"\",\n \"temporaryImageIds\": [\n \"\",\n \"\"\n ],\n \"defaultTemporaryImageId\": \"\",\n \"defaultImageId\": \"\",\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n }\n ],\n \"stockMinimums\": [\n {\n \"warehouseId\": \"\",\n \"minimumStock\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"minimumStock\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a4152e58-40b5-4e72-b3b8-42ddad71ecca", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"modelCode\": \"\",\n \"reference\": \"\",\n \"alias\": \"\",\n \"cabysCode\": \"\",\n \"externalId\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"blockType\": \"\",\n \"manufacturable\": \"\",\n \"inventoriable\": \"\",\n \"needsRawMaterial\": \"\",\n \"batchRequired\": \"\",\n \"priceEditable\": \"\",\n \"online\": \"\",\n \"fabricabilityByVariant\": \"\",\n \"material\": \"\",\n \"frameType\": \"\",\n \"gender\": \"\",\n \"usefulLifeDays\": \"\",\n \"currencyCode\": \"\",\n \"systemCurrencyCode\": \"\",\n \"lensIndex\": \"\",\n \"lensStrx\": \"\",\n \"lensMaterial\": \"\",\n \"lensShape\": \"\",\n \"onlineName\": \"\",\n \"shortDescription\": \"\",\n \"extendedDescription\": \"\",\n \"linkRewrite\": \"\",\n \"webStockManagementType\": \"\",\n \"webVisibilityType\": \"\",\n \"onlineChannelIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\",\n \"supplierId\": \"\",\n \"categoryId\": \"\",\n \"brandId\": \"\",\n \"groupId\": \"\",\n \"campaignId\": \"\",\n \"collectionId\": \"\",\n \"rangeId\": \"\",\n \"itemTypeId\": \"\",\n \"vatTypeId\": \"\",\n \"additionalCategoryIds\": [\n \"\",\n \"\"\n ],\n \"defaultVariantId\": \"\",\n \"caseProductId\": \"\",\n \"workOrderProductId\": \"\",\n \"temporaryImageIds\": [\n \"\",\n \"\"\n ],\n \"defaultTemporaryImageId\": \"\",\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n }\n ],\n \"variantCustomFieldIds\": [\n \"\",\n \"\"\n ],\n \"manufacturingFieldIds\": [\n \"\",\n \"\"\n ],\n \"variants\": [\n {\n \"id\": \"\",\n \"barCode\": \"\",\n \"gtin\": \"\",\n \"reference\": \"\",\n \"description\": \"\",\n \"supplierDescription\": \"\",\n \"color\": \"\",\n \"rod\": \"\",\n \"bridge\": \"\",\n \"horizontalDiameter\": \"\",\n \"verticalDiameter\": \"\",\n \"usefulLifeDays\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"discontinued\": \"\",\n \"batch\": \"\",\n \"purchasePriceNet\": \"\",\n \"purchasePriceGross\": \"\",\n \"salePriceNet\": \"\",\n \"salePriceGross\": \"\",\n \"factor\": \"\",\n \"margin\": \"\",\n \"vatTypeId\": \"\",\n \"packQuantity\": \"\",\n \"packProductId\": \"\",\n \"temporaryImageIds\": [\n \"\",\n \"\"\n ],\n \"defaultTemporaryImageId\": \"\",\n \"defaultImageId\": \"\",\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n }\n ],\n \"stockMinimums\": [\n {\n \"warehouseId\": \"\",\n \"minimumStock\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"minimumStock\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"barCode\": \"\",\n \"gtin\": \"\",\n \"reference\": \"\",\n \"description\": \"\",\n \"supplierDescription\": \"\",\n \"color\": \"\",\n \"rod\": \"\",\n \"bridge\": \"\",\n \"horizontalDiameter\": \"\",\n \"verticalDiameter\": \"\",\n \"usefulLifeDays\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"discontinued\": \"\",\n \"batch\": \"\",\n \"purchasePriceNet\": \"\",\n \"purchasePriceGross\": \"\",\n \"salePriceNet\": \"\",\n \"salePriceGross\": \"\",\n \"factor\": \"\",\n \"margin\": \"\",\n \"vatTypeId\": \"\",\n \"packQuantity\": \"\",\n \"packProductId\": \"\",\n \"temporaryImageIds\": [\n \"\",\n \"\"\n ],\n \"defaultTemporaryImageId\": \"\",\n \"defaultImageId\": \"\",\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n }\n ],\n \"stockMinimums\": [\n {\n \"warehouseId\": \"\",\n \"minimumStock\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"minimumStock\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "593f58d1-87de-4a70-af71-cebdf1bb156f", "name": "Authenticated user is missing the `CREAR_MODELOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"modelCode\": \"\",\n \"reference\": \"\",\n \"alias\": \"\",\n \"cabysCode\": \"\",\n \"externalId\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"blockType\": \"\",\n \"manufacturable\": \"\",\n \"inventoriable\": \"\",\n \"needsRawMaterial\": \"\",\n \"batchRequired\": \"\",\n \"priceEditable\": \"\",\n \"online\": \"\",\n \"fabricabilityByVariant\": \"\",\n \"material\": \"\",\n \"frameType\": \"\",\n \"gender\": \"\",\n \"usefulLifeDays\": \"\",\n \"currencyCode\": \"\",\n \"systemCurrencyCode\": \"\",\n \"lensIndex\": \"\",\n \"lensStrx\": \"\",\n \"lensMaterial\": \"\",\n \"lensShape\": \"\",\n \"onlineName\": \"\",\n \"shortDescription\": \"\",\n \"extendedDescription\": \"\",\n \"linkRewrite\": \"\",\n \"webStockManagementType\": \"\",\n \"webVisibilityType\": \"\",\n \"onlineChannelIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\",\n \"supplierId\": \"\",\n \"categoryId\": \"\",\n \"brandId\": \"\",\n \"groupId\": \"\",\n \"campaignId\": \"\",\n \"collectionId\": \"\",\n \"rangeId\": \"\",\n \"itemTypeId\": \"\",\n \"vatTypeId\": \"\",\n \"additionalCategoryIds\": [\n \"\",\n \"\"\n ],\n \"defaultVariantId\": \"\",\n \"caseProductId\": \"\",\n \"workOrderProductId\": \"\",\n \"temporaryImageIds\": [\n \"\",\n \"\"\n ],\n \"defaultTemporaryImageId\": \"\",\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n }\n ],\n \"variantCustomFieldIds\": [\n \"\",\n \"\"\n ],\n \"manufacturingFieldIds\": [\n \"\",\n \"\"\n ],\n \"variants\": [\n {\n \"id\": \"\",\n \"barCode\": \"\",\n \"gtin\": \"\",\n \"reference\": \"\",\n \"description\": \"\",\n \"supplierDescription\": \"\",\n \"color\": \"\",\n \"rod\": \"\",\n \"bridge\": \"\",\n \"horizontalDiameter\": \"\",\n \"verticalDiameter\": \"\",\n \"usefulLifeDays\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"discontinued\": \"\",\n \"batch\": \"\",\n \"purchasePriceNet\": \"\",\n \"purchasePriceGross\": \"\",\n \"salePriceNet\": \"\",\n \"salePriceGross\": \"\",\n \"factor\": \"\",\n \"margin\": \"\",\n \"vatTypeId\": \"\",\n \"packQuantity\": \"\",\n \"packProductId\": \"\",\n \"temporaryImageIds\": [\n \"\",\n \"\"\n ],\n \"defaultTemporaryImageId\": \"\",\n \"defaultImageId\": \"\",\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n }\n ],\n \"stockMinimums\": [\n {\n \"warehouseId\": \"\",\n \"minimumStock\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"minimumStock\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"barCode\": \"\",\n \"gtin\": \"\",\n \"reference\": \"\",\n \"description\": \"\",\n \"supplierDescription\": \"\",\n \"color\": \"\",\n \"rod\": \"\",\n \"bridge\": \"\",\n \"horizontalDiameter\": \"\",\n \"verticalDiameter\": \"\",\n \"usefulLifeDays\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"discontinued\": \"\",\n \"batch\": \"\",\n \"purchasePriceNet\": \"\",\n \"purchasePriceGross\": \"\",\n \"salePriceNet\": \"\",\n \"salePriceGross\": \"\",\n \"factor\": \"\",\n \"margin\": \"\",\n \"vatTypeId\": \"\",\n \"packQuantity\": \"\",\n \"packProductId\": \"\",\n \"temporaryImageIds\": [\n \"\",\n \"\"\n ],\n \"defaultTemporaryImageId\": \"\",\n \"defaultImageId\": \"\",\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n }\n ],\n \"stockMinimums\": [\n {\n \"warehouseId\": \"\",\n \"minimumStock\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"minimumStock\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2ff2ae8c-93ca-4200-b826-8a197f950bcc", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"modelCode\": \"\",\n \"reference\": \"\",\n \"alias\": \"\",\n \"cabysCode\": \"\",\n \"externalId\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"blockType\": \"\",\n \"manufacturable\": \"\",\n \"inventoriable\": \"\",\n \"needsRawMaterial\": \"\",\n \"batchRequired\": \"\",\n \"priceEditable\": \"\",\n \"online\": \"\",\n \"fabricabilityByVariant\": \"\",\n \"material\": \"\",\n \"frameType\": \"\",\n \"gender\": \"\",\n \"usefulLifeDays\": \"\",\n \"currencyCode\": \"\",\n \"systemCurrencyCode\": \"\",\n \"lensIndex\": \"\",\n \"lensStrx\": \"\",\n \"lensMaterial\": \"\",\n \"lensShape\": \"\",\n \"onlineName\": \"\",\n \"shortDescription\": \"\",\n \"extendedDescription\": \"\",\n \"linkRewrite\": \"\",\n \"webStockManagementType\": \"\",\n \"webVisibilityType\": \"\",\n \"onlineChannelIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\",\n \"supplierId\": \"\",\n \"categoryId\": \"\",\n \"brandId\": \"\",\n \"groupId\": \"\",\n \"campaignId\": \"\",\n \"collectionId\": \"\",\n \"rangeId\": \"\",\n \"itemTypeId\": \"\",\n \"vatTypeId\": \"\",\n \"additionalCategoryIds\": [\n \"\",\n \"\"\n ],\n \"defaultVariantId\": \"\",\n \"caseProductId\": \"\",\n \"workOrderProductId\": \"\",\n \"temporaryImageIds\": [\n \"\",\n \"\"\n ],\n \"defaultTemporaryImageId\": \"\",\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n }\n ],\n \"variantCustomFieldIds\": [\n \"\",\n \"\"\n ],\n \"manufacturingFieldIds\": [\n \"\",\n \"\"\n ],\n \"variants\": [\n {\n \"id\": \"\",\n \"barCode\": \"\",\n \"gtin\": \"\",\n \"reference\": \"\",\n \"description\": \"\",\n \"supplierDescription\": \"\",\n \"color\": \"\",\n \"rod\": \"\",\n \"bridge\": \"\",\n \"horizontalDiameter\": \"\",\n \"verticalDiameter\": \"\",\n \"usefulLifeDays\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"discontinued\": \"\",\n \"batch\": \"\",\n \"purchasePriceNet\": \"\",\n \"purchasePriceGross\": \"\",\n \"salePriceNet\": \"\",\n \"salePriceGross\": \"\",\n \"factor\": \"\",\n \"margin\": \"\",\n \"vatTypeId\": \"\",\n \"packQuantity\": \"\",\n \"packProductId\": \"\",\n \"temporaryImageIds\": [\n \"\",\n \"\"\n ],\n \"defaultTemporaryImageId\": \"\",\n \"defaultImageId\": \"\",\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n }\n ],\n \"stockMinimums\": [\n {\n \"warehouseId\": \"\",\n \"minimumStock\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"minimumStock\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"barCode\": \"\",\n \"gtin\": \"\",\n \"reference\": \"\",\n \"description\": \"\",\n \"supplierDescription\": \"\",\n \"color\": \"\",\n \"rod\": \"\",\n \"bridge\": \"\",\n \"horizontalDiameter\": \"\",\n \"verticalDiameter\": \"\",\n \"usefulLifeDays\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"discontinued\": \"\",\n \"batch\": \"\",\n \"purchasePriceNet\": \"\",\n \"purchasePriceGross\": \"\",\n \"salePriceNet\": \"\",\n \"salePriceGross\": \"\",\n \"factor\": \"\",\n \"margin\": \"\",\n \"vatTypeId\": \"\",\n \"packQuantity\": \"\",\n \"packProductId\": \"\",\n \"temporaryImageIds\": [\n \"\",\n \"\"\n ],\n \"defaultTemporaryImageId\": \"\",\n \"defaultImageId\": \"\",\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n }\n ],\n \"stockMinimums\": [\n {\n \"warehouseId\": \"\",\n \"minimumStock\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"minimumStock\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "images", "description": "", "item": [ { "id": "a60784f1-8edf-48c0-b6bf-a75e4be72211", "name": "Upload temporary product images", "request": { "name": "Upload temporary product images", "description": { "content": "Uploads one or more images to the legacy temporary storage. Use the returned `temporaryImageId` values in `temporaryImageIds` or `defaultTemporaryImageId` when creating/updating a product.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "products", "images" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Company ID that owns the future/existing product", "type": "text/plain" }, "key": "companyId", "value": "" }, { "disabled": false, "description": { "content": "(Required) Image files to upload", "type": "text/plain" }, "key": "files", "value": "" }, { "disabled": false, "description": { "content": "(Required) Image files to upload", "type": "text/plain" }, "key": "files", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "5bb20188-3d40-4177-8f43-f4bb9339e0c4", "name": "Temporary product images uploaded", "originalRequest": { "url": { "path": [ "api", "v2", "products", "images" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Company ID that owns the future/existing product", "type": "text/plain" }, "key": "companyId", "value": "" }, { "disabled": false, "description": { "content": "(Required) Image files to upload", "type": "text/plain" }, "key": "files", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"temporaryImageId\": \"\",\n \"url\": \"\",\n \"fileName\": \"\",\n \"extension\": \"\",\n \"size\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cbf1cae1-6efc-4705-bb87-831e2e20f1ec", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "products", "images" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Company ID that owns the future/existing product", "type": "text/plain" }, "key": "companyId", "value": "" }, { "disabled": false, "description": { "content": "(Required) Image files to upload", "type": "text/plain" }, "key": "files", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "78da284a-5f0a-49d9-b2fc-130997297578", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "products", "images" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Company ID that owns the future/existing product", "type": "text/plain" }, "key": "companyId", "value": "" }, { "disabled": false, "description": { "content": "(Required) Image files to upload", "type": "text/plain" }, "key": "files", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "51689a05-6be8-4579-a971-55c492e38376", "name": "Authenticated user is missing the `CREAR_MODELOS` or `EDITAR_MODELOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "products", "images" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Company ID that owns the future/existing product", "type": "text/plain" }, "key": "companyId", "value": "" }, { "disabled": false, "description": { "content": "(Required) Image files to upload", "type": "text/plain" }, "key": "files", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0c77a6cf-4dfc-4b81-8476-96f4ec08527d", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "products", "images" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Company ID that owns the future/existing product", "type": "text/plain" }, "key": "companyId", "value": "" }, { "disabled": false, "description": { "content": "(Required) Image files to upload", "type": "text/plain" }, "key": "files", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "price-lists", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "71586e76-6d1e-4ca3-9d47-790a8ec17294", "name": "Get price list by ID", "request": { "name": "Get price list by ID", "description": { "content": "Returns a single price list including branch schedules, payment method constraints and card types. The response carries an `ETag` header.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "price-lists", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "f0620019-8eb3-4db7-8e7f-f00ff896b12f", "name": "Price list found", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"priceListType\": \"DTO\",\n \"enabled\": \"\",\n \"active\": \"\",\n \"draft\": \"\",\n \"forSales\": \"\",\n \"stackable\": \"\",\n \"appliesOnPartialPayment\": \"\",\n \"requiresValues\": \"\",\n \"usesProductBaseValue\": \"\",\n \"priceSourceType\": \"PC\",\n \"blockType\": \"\",\n \"effectiveFrom\": \"\",\n \"effectiveTo\": \"\",\n \"currencyCode\": \"\",\n \"purchaseConditionsCount\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"sourcePriceListId\": \"\",\n \"sourcePriceListName\": \"\",\n \"paymentMethodIds\": [\n \"\",\n \"\"\n ],\n \"cardTypes\": [\n \"\",\n \"\"\n ],\n \"branchSchedules\": [\n {\n \"id\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"fromDate\": \"\",\n \"toDate\": \"\",\n \"fromTime\": \"\",\n \"toTime\": \"\",\n \"monday\": \"\",\n \"tuesday\": \"\",\n \"wednesday\": \"\",\n \"thursday\": \"\",\n \"friday\": \"\",\n \"saturday\": \"\",\n \"sunday\": \"\"\n },\n {\n \"id\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"fromDate\": \"\",\n \"toDate\": \"\",\n \"fromTime\": \"\",\n \"toTime\": \"\",\n \"monday\": \"\",\n \"tuesday\": \"\",\n \"wednesday\": \"\",\n \"thursday\": \"\",\n \"friday\": \"\",\n \"saturday\": \"\",\n \"sunday\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9f45f86b-f667-43ca-b956-f8a7e8db05cd", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "78260051-7cbd-431a-a1d7-6cf912e38a8f", "name": "Authenticated user is missing the `VER_TARIFAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5ed49b72-fa71-4ff5-8315-512fa78bc1f0", "name": "Price list not found", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f6c8b3d8-110f-4432-b6dc-fa3c8091eb3e", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0c9536a0-ccf6-466c-8fad-9431d42375a4", "name": "Update price list", "request": { "name": "Update price list", "description": { "content": "Full replacement of an existing price list. Also finalises a draft: the server clears `draft` on every update. `branchSchedules` and `paymentMethodIds` follow the collection contract: null = untouched, [] = clear, non-empty = full replacement.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "price-lists", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"priceListType\": \"TB\",\n \"enabled\": \"\",\n \"active\": \"\",\n \"forSales\": \"\",\n \"stackable\": \"\",\n \"appliesOnPartialPayment\": \"\",\n \"requiresValues\": \"\",\n \"usesProductBaseValue\": \"\",\n \"priceSourceType\": \"PC\",\n \"effectiveFrom\": \"\",\n \"effectiveTo\": \"\",\n \"currencyCode\": \"\",\n \"companyId\": \"\",\n \"sourcePriceListId\": \"\",\n \"paymentMethodIds\": [\n \"\",\n \"\"\n ],\n \"cardTypes\": [\n \"\",\n \"\"\n ],\n \"branchSchedules\": [\n {\n \"warehouseId\": \"\",\n \"fromDate\": \"\",\n \"toDate\": \"\",\n \"fromTime\": \"\",\n \"toTime\": \"\",\n \"monday\": \"\",\n \"tuesday\": \"\",\n \"wednesday\": \"\",\n \"thursday\": \"\",\n \"friday\": \"\",\n \"saturday\": \"\",\n \"sunday\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"fromDate\": \"\",\n \"toDate\": \"\",\n \"fromTime\": \"\",\n \"toTime\": \"\",\n \"monday\": \"\",\n \"tuesday\": \"\",\n \"wednesday\": \"\",\n \"thursday\": \"\",\n \"friday\": \"\",\n \"saturday\": \"\",\n \"sunday\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "2ddbf9a4-f96f-42d5-b6bb-6f2643818c06", "name": "Price list updated", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"priceListType\": \"TB\",\n \"enabled\": \"\",\n \"active\": \"\",\n \"forSales\": \"\",\n \"stackable\": \"\",\n \"appliesOnPartialPayment\": \"\",\n \"requiresValues\": \"\",\n \"usesProductBaseValue\": \"\",\n \"priceSourceType\": \"PC\",\n \"effectiveFrom\": \"\",\n \"effectiveTo\": \"\",\n \"currencyCode\": \"\",\n \"companyId\": \"\",\n \"sourcePriceListId\": \"\",\n \"paymentMethodIds\": [\n \"\",\n \"\"\n ],\n \"cardTypes\": [\n \"\",\n \"\"\n ],\n \"branchSchedules\": [\n {\n \"warehouseId\": \"\",\n \"fromDate\": \"\",\n \"toDate\": \"\",\n \"fromTime\": \"\",\n \"toTime\": \"\",\n \"monday\": \"\",\n \"tuesday\": \"\",\n \"wednesday\": \"\",\n \"thursday\": \"\",\n \"friday\": \"\",\n \"saturday\": \"\",\n \"sunday\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"fromDate\": \"\",\n \"toDate\": \"\",\n \"fromTime\": \"\",\n \"toTime\": \"\",\n \"monday\": \"\",\n \"tuesday\": \"\",\n \"wednesday\": \"\",\n \"thursday\": \"\",\n \"friday\": \"\",\n \"saturday\": \"\",\n \"sunday\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"priceListType\": \"DTO\",\n \"enabled\": \"\",\n \"active\": \"\",\n \"draft\": \"\",\n \"forSales\": \"\",\n \"stackable\": \"\",\n \"appliesOnPartialPayment\": \"\",\n \"requiresValues\": \"\",\n \"usesProductBaseValue\": \"\",\n \"priceSourceType\": \"PC\",\n \"blockType\": \"\",\n \"effectiveFrom\": \"\",\n \"effectiveTo\": \"\",\n \"currencyCode\": \"\",\n \"purchaseConditionsCount\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"sourcePriceListId\": \"\",\n \"sourcePriceListName\": \"\",\n \"paymentMethodIds\": [\n \"\",\n \"\"\n ],\n \"cardTypes\": [\n \"\",\n \"\"\n ],\n \"branchSchedules\": [\n {\n \"id\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"fromDate\": \"\",\n \"toDate\": \"\",\n \"fromTime\": \"\",\n \"toTime\": \"\",\n \"monday\": \"\",\n \"tuesday\": \"\",\n \"wednesday\": \"\",\n \"thursday\": \"\",\n \"friday\": \"\",\n \"saturday\": \"\",\n \"sunday\": \"\"\n },\n {\n \"id\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"fromDate\": \"\",\n \"toDate\": \"\",\n \"fromTime\": \"\",\n \"toTime\": \"\",\n \"monday\": \"\",\n \"tuesday\": \"\",\n \"wednesday\": \"\",\n \"thursday\": \"\",\n \"friday\": \"\",\n \"saturday\": \"\",\n \"sunday\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5f00c385-e9f5-4471-8d8f-03afce759181", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"priceListType\": \"TB\",\n \"enabled\": \"\",\n \"active\": \"\",\n \"forSales\": \"\",\n \"stackable\": \"\",\n \"appliesOnPartialPayment\": \"\",\n \"requiresValues\": \"\",\n \"usesProductBaseValue\": \"\",\n \"priceSourceType\": \"PC\",\n \"effectiveFrom\": \"\",\n \"effectiveTo\": \"\",\n \"currencyCode\": \"\",\n \"companyId\": \"\",\n \"sourcePriceListId\": \"\",\n \"paymentMethodIds\": [\n \"\",\n \"\"\n ],\n \"cardTypes\": [\n \"\",\n \"\"\n ],\n \"branchSchedules\": [\n {\n \"warehouseId\": \"\",\n \"fromDate\": \"\",\n \"toDate\": \"\",\n \"fromTime\": \"\",\n \"toTime\": \"\",\n \"monday\": \"\",\n \"tuesday\": \"\",\n \"wednesday\": \"\",\n \"thursday\": \"\",\n \"friday\": \"\",\n \"saturday\": \"\",\n \"sunday\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"fromDate\": \"\",\n \"toDate\": \"\",\n \"fromTime\": \"\",\n \"toTime\": \"\",\n \"monday\": \"\",\n \"tuesday\": \"\",\n \"wednesday\": \"\",\n \"thursday\": \"\",\n \"friday\": \"\",\n \"saturday\": \"\",\n \"sunday\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d52b0022-a1a6-438d-ab94-9e7c893bb75d", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"priceListType\": \"TB\",\n \"enabled\": \"\",\n \"active\": \"\",\n \"forSales\": \"\",\n \"stackable\": \"\",\n \"appliesOnPartialPayment\": \"\",\n \"requiresValues\": \"\",\n \"usesProductBaseValue\": \"\",\n \"priceSourceType\": \"PC\",\n \"effectiveFrom\": \"\",\n \"effectiveTo\": \"\",\n \"currencyCode\": \"\",\n \"companyId\": \"\",\n \"sourcePriceListId\": \"\",\n \"paymentMethodIds\": [\n \"\",\n \"\"\n ],\n \"cardTypes\": [\n \"\",\n \"\"\n ],\n \"branchSchedules\": [\n {\n \"warehouseId\": \"\",\n \"fromDate\": \"\",\n \"toDate\": \"\",\n \"fromTime\": \"\",\n \"toTime\": \"\",\n \"monday\": \"\",\n \"tuesday\": \"\",\n \"wednesday\": \"\",\n \"thursday\": \"\",\n \"friday\": \"\",\n \"saturday\": \"\",\n \"sunday\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"fromDate\": \"\",\n \"toDate\": \"\",\n \"fromTime\": \"\",\n \"toTime\": \"\",\n \"monday\": \"\",\n \"tuesday\": \"\",\n \"wednesday\": \"\",\n \"thursday\": \"\",\n \"friday\": \"\",\n \"saturday\": \"\",\n \"sunday\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ecde47e7-7d46-455f-8063-397df65419c0", "name": "Authenticated user is missing the `EDITAR_TARIFAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"priceListType\": \"TB\",\n \"enabled\": \"\",\n \"active\": \"\",\n \"forSales\": \"\",\n \"stackable\": \"\",\n \"appliesOnPartialPayment\": \"\",\n \"requiresValues\": \"\",\n \"usesProductBaseValue\": \"\",\n \"priceSourceType\": \"PC\",\n \"effectiveFrom\": \"\",\n \"effectiveTo\": \"\",\n \"currencyCode\": \"\",\n \"companyId\": \"\",\n \"sourcePriceListId\": \"\",\n \"paymentMethodIds\": [\n \"\",\n \"\"\n ],\n \"cardTypes\": [\n \"\",\n \"\"\n ],\n \"branchSchedules\": [\n {\n \"warehouseId\": \"\",\n \"fromDate\": \"\",\n \"toDate\": \"\",\n \"fromTime\": \"\",\n \"toTime\": \"\",\n \"monday\": \"\",\n \"tuesday\": \"\",\n \"wednesday\": \"\",\n \"thursday\": \"\",\n \"friday\": \"\",\n \"saturday\": \"\",\n \"sunday\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"fromDate\": \"\",\n \"toDate\": \"\",\n \"fromTime\": \"\",\n \"toTime\": \"\",\n \"monday\": \"\",\n \"tuesday\": \"\",\n \"wednesday\": \"\",\n \"thursday\": \"\",\n \"friday\": \"\",\n \"saturday\": \"\",\n \"sunday\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "66be7066-baa7-4095-8bab-8540eb020e12", "name": "Price list not found", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"priceListType\": \"TB\",\n \"enabled\": \"\",\n \"active\": \"\",\n \"forSales\": \"\",\n \"stackable\": \"\",\n \"appliesOnPartialPayment\": \"\",\n \"requiresValues\": \"\",\n \"usesProductBaseValue\": \"\",\n \"priceSourceType\": \"PC\",\n \"effectiveFrom\": \"\",\n \"effectiveTo\": \"\",\n \"currencyCode\": \"\",\n \"companyId\": \"\",\n \"sourcePriceListId\": \"\",\n \"paymentMethodIds\": [\n \"\",\n \"\"\n ],\n \"cardTypes\": [\n \"\",\n \"\"\n ],\n \"branchSchedules\": [\n {\n \"warehouseId\": \"\",\n \"fromDate\": \"\",\n \"toDate\": \"\",\n \"fromTime\": \"\",\n \"toTime\": \"\",\n \"monday\": \"\",\n \"tuesday\": \"\",\n \"wednesday\": \"\",\n \"thursday\": \"\",\n \"friday\": \"\",\n \"saturday\": \"\",\n \"sunday\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"fromDate\": \"\",\n \"toDate\": \"\",\n \"fromTime\": \"\",\n \"toTime\": \"\",\n \"monday\": \"\",\n \"tuesday\": \"\",\n \"wednesday\": \"\",\n \"thursday\": \"\",\n \"friday\": \"\",\n \"saturday\": \"\",\n \"sunday\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "22d31f69-4ba9-495b-a7eb-7102fe033d79", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"priceListType\": \"TB\",\n \"enabled\": \"\",\n \"active\": \"\",\n \"forSales\": \"\",\n \"stackable\": \"\",\n \"appliesOnPartialPayment\": \"\",\n \"requiresValues\": \"\",\n \"usesProductBaseValue\": \"\",\n \"priceSourceType\": \"PC\",\n \"effectiveFrom\": \"\",\n \"effectiveTo\": \"\",\n \"currencyCode\": \"\",\n \"companyId\": \"\",\n \"sourcePriceListId\": \"\",\n \"paymentMethodIds\": [\n \"\",\n \"\"\n ],\n \"cardTypes\": [\n \"\",\n \"\"\n ],\n \"branchSchedules\": [\n {\n \"warehouseId\": \"\",\n \"fromDate\": \"\",\n \"toDate\": \"\",\n \"fromTime\": \"\",\n \"toTime\": \"\",\n \"monday\": \"\",\n \"tuesday\": \"\",\n \"wednesday\": \"\",\n \"thursday\": \"\",\n \"friday\": \"\",\n \"saturday\": \"\",\n \"sunday\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"fromDate\": \"\",\n \"toDate\": \"\",\n \"fromTime\": \"\",\n \"toTime\": \"\",\n \"monday\": \"\",\n \"tuesday\": \"\",\n \"wednesday\": \"\",\n \"thursday\": \"\",\n \"friday\": \"\",\n \"saturday\": \"\",\n \"sunday\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d58e6b06-1aed-47e0-b71f-dd091a96fc84", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"priceListType\": \"TB\",\n \"enabled\": \"\",\n \"active\": \"\",\n \"forSales\": \"\",\n \"stackable\": \"\",\n \"appliesOnPartialPayment\": \"\",\n \"requiresValues\": \"\",\n \"usesProductBaseValue\": \"\",\n \"priceSourceType\": \"PC\",\n \"effectiveFrom\": \"\",\n \"effectiveTo\": \"\",\n \"currencyCode\": \"\",\n \"companyId\": \"\",\n \"sourcePriceListId\": \"\",\n \"paymentMethodIds\": [\n \"\",\n \"\"\n ],\n \"cardTypes\": [\n \"\",\n \"\"\n ],\n \"branchSchedules\": [\n {\n \"warehouseId\": \"\",\n \"fromDate\": \"\",\n \"toDate\": \"\",\n \"fromTime\": \"\",\n \"toTime\": \"\",\n \"monday\": \"\",\n \"tuesday\": \"\",\n \"wednesday\": \"\",\n \"thursday\": \"\",\n \"friday\": \"\",\n \"saturday\": \"\",\n \"sunday\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"fromDate\": \"\",\n \"toDate\": \"\",\n \"fromTime\": \"\",\n \"toTime\": \"\",\n \"monday\": \"\",\n \"tuesday\": \"\",\n \"wednesday\": \"\",\n \"thursday\": \"\",\n \"friday\": \"\",\n \"saturday\": \"\",\n \"sunday\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bc32d2bd-c28c-4e16-8ad2-468f61a71431", "name": "Delete price list", "request": { "name": "Delete price list", "description": { "content": "Deletes a price list (also used to cancel a draft created by `POST /new`).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "price-lists", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "961a7784-0d85-408e-9590-152562911e16", "name": "Price list deleted", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9a242f43-62b7-44f3-b46b-830fc2c95476", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "41ad7041-2925-43cd-a459-bed15a16fded", "name": "Authenticated user is missing the `BORRAR_TARIFAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ec9a247f-e7d9-471f-a7bb-d3934bbb63d9", "name": "Price list not found", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bc80a656-38cc-4ab2-ba3f-7efeefbb8fea", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "717149b6-4bb7-4b0e-86ad-48e8c4cc5c01", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bb755286-c6c7-458c-abf7-44b5c5e69654", "name": "Merge-patch price list", "request": { "name": "Merge-patch price list", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "price-lists", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "14ecc553-858b-454a-87a3-15eed337894d", "name": "Price list patched", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"priceListType\": \"DTO\",\n \"enabled\": \"\",\n \"active\": \"\",\n \"draft\": \"\",\n \"forSales\": \"\",\n \"stackable\": \"\",\n \"appliesOnPartialPayment\": \"\",\n \"requiresValues\": \"\",\n \"usesProductBaseValue\": \"\",\n \"priceSourceType\": \"PC\",\n \"blockType\": \"\",\n \"effectiveFrom\": \"\",\n \"effectiveTo\": \"\",\n \"currencyCode\": \"\",\n \"purchaseConditionsCount\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"sourcePriceListId\": \"\",\n \"sourcePriceListName\": \"\",\n \"paymentMethodIds\": [\n \"\",\n \"\"\n ],\n \"cardTypes\": [\n \"\",\n \"\"\n ],\n \"branchSchedules\": [\n {\n \"id\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"fromDate\": \"\",\n \"toDate\": \"\",\n \"fromTime\": \"\",\n \"toTime\": \"\",\n \"monday\": \"\",\n \"tuesday\": \"\",\n \"wednesday\": \"\",\n \"thursday\": \"\",\n \"friday\": \"\",\n \"saturday\": \"\",\n \"sunday\": \"\"\n },\n {\n \"id\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"fromDate\": \"\",\n \"toDate\": \"\",\n \"fromTime\": \"\",\n \"toTime\": \"\",\n \"monday\": \"\",\n \"tuesday\": \"\",\n \"wednesday\": \"\",\n \"thursday\": \"\",\n \"friday\": \"\",\n \"saturday\": \"\",\n \"sunday\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8c059e17-e792-4e68-a565-ab7908c1d22b", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details. Also returned for malformed merge-patch payloads.", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0b3e37c6-f3f0-488d-80c3-3494045cd737", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6a2ecde7-86bd-45dc-ad13-099d9ec11f0a", "name": "Authenticated user is missing the `EDITAR_TARIFAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2c811e5e-0f63-439e-aabe-fa4f0995e802", "name": "Price list not found", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f527b4e7-04e5-4cda-919e-61b3444e3ea5", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3a16c4e6-63af-48da-ba3d-29f6d69676af", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "entries", "description": "", "item": [ { "name": "{entryId}", "description": "", "item": [ { "id": "8b5b3640-62be-4fae-a608-b2cb3d647b2f", "name": "Update price list entry", "request": { "name": "Update price list entry", "description": { "content": "Updates the value fields of an entry (price, discountPercent, factor, finalPrice, vatIncluded, reference). The target product is immutable.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "price-lists", ":id", "entries", ":entryId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" } }, { "type": "any", "value": "", "key": "entryId", "disabled": false, "description": { "content": "(Required) Entry ID", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"productId\": \"\",\n \"reference\": \"\",\n \"price\": \"\",\n \"discountPercent\": \"\",\n \"factor\": \"\",\n \"finalPrice\": \"\",\n \"vatIncluded\": \"\",\n \"comboConditionId\": \"\",\n \"categoryId\": \"\",\n \"brandId\": \"\",\n \"groupId\": \"\",\n \"campaignId\": \"\",\n \"counterpartyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "491a3966-4767-4091-af70-5a419f7952ed", "name": "Entry updated", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "entries", ":entryId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) Entry ID", "type": "text/plain" }, "type": "any", "value": "", "key": "entryId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"productId\": \"\",\n \"reference\": \"\",\n \"price\": \"\",\n \"discountPercent\": \"\",\n \"factor\": \"\",\n \"finalPrice\": \"\",\n \"vatIncluded\": \"\",\n \"comboConditionId\": \"\",\n \"categoryId\": \"\",\n \"brandId\": \"\",\n \"groupId\": \"\",\n \"campaignId\": \"\",\n \"counterpartyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"priceListId\": \"\",\n \"priceListType\": \"DTO\",\n \"productId\": \"\",\n \"productName\": \"\",\n \"productReference\": \"\",\n \"reference\": \"\",\n \"price\": \"\",\n \"discountPercent\": \"\",\n \"factor\": \"\",\n \"finalPrice\": \"\",\n \"vatIncluded\": \"\",\n \"forSales\": \"\",\n \"comboConditionId\": \"\",\n \"ruleOrder\": \"\",\n \"categoryId\": \"\",\n \"categoryName\": \"\",\n \"brandId\": \"\",\n \"brandName\": \"\",\n \"groupId\": \"\",\n \"groupName\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"counterpartyId\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e6a16189-803b-45e9-b6c8-d208cebe858d", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "entries", ":entryId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) Entry ID", "type": "text/plain" }, "type": "any", "value": "", "key": "entryId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"productId\": \"\",\n \"reference\": \"\",\n \"price\": \"\",\n \"discountPercent\": \"\",\n \"factor\": \"\",\n \"finalPrice\": \"\",\n \"vatIncluded\": \"\",\n \"comboConditionId\": \"\",\n \"categoryId\": \"\",\n \"brandId\": \"\",\n \"groupId\": \"\",\n \"campaignId\": \"\",\n \"counterpartyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b3a9fecd-64dc-402d-a0d0-4886f7178b97", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "entries", ":entryId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) Entry ID", "type": "text/plain" }, "type": "any", "value": "", "key": "entryId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"productId\": \"\",\n \"reference\": \"\",\n \"price\": \"\",\n \"discountPercent\": \"\",\n \"factor\": \"\",\n \"finalPrice\": \"\",\n \"vatIncluded\": \"\",\n \"comboConditionId\": \"\",\n \"categoryId\": \"\",\n \"brandId\": \"\",\n \"groupId\": \"\",\n \"campaignId\": \"\",\n \"counterpartyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fa1871c3-c77e-4a49-8eb3-c0580e189881", "name": "Authenticated user is missing the `EDITAR_TARIFAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "entries", ":entryId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) Entry ID", "type": "text/plain" }, "type": "any", "value": "", "key": "entryId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"productId\": \"\",\n \"reference\": \"\",\n \"price\": \"\",\n \"discountPercent\": \"\",\n \"factor\": \"\",\n \"finalPrice\": \"\",\n \"vatIncluded\": \"\",\n \"comboConditionId\": \"\",\n \"categoryId\": \"\",\n \"brandId\": \"\",\n \"groupId\": \"\",\n \"campaignId\": \"\",\n \"counterpartyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "44a721c3-8be7-4e16-831c-43343c7863c2", "name": "Price list or entry not found", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "entries", ":entryId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) Entry ID", "type": "text/plain" }, "type": "any", "value": "", "key": "entryId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"productId\": \"\",\n \"reference\": \"\",\n \"price\": \"\",\n \"discountPercent\": \"\",\n \"factor\": \"\",\n \"finalPrice\": \"\",\n \"vatIncluded\": \"\",\n \"comboConditionId\": \"\",\n \"categoryId\": \"\",\n \"brandId\": \"\",\n \"groupId\": \"\",\n \"campaignId\": \"\",\n \"counterpartyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "df982df4-9d08-4993-b204-c3faf0220964", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "entries", ":entryId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) Entry ID", "type": "text/plain" }, "type": "any", "value": "", "key": "entryId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"productId\": \"\",\n \"reference\": \"\",\n \"price\": \"\",\n \"discountPercent\": \"\",\n \"factor\": \"\",\n \"finalPrice\": \"\",\n \"vatIncluded\": \"\",\n \"comboConditionId\": \"\",\n \"categoryId\": \"\",\n \"brandId\": \"\",\n \"groupId\": \"\",\n \"campaignId\": \"\",\n \"counterpartyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "56c9596f-d173-4f94-8a58-162cf2e8cbcf", "name": "Delete price list entry", "request": { "name": "Delete price list entry", "description": { "content": "Deletes one entry (product price or discount rule row).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "price-lists", ":id", "entries", ":entryId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" } }, { "type": "any", "value": "", "key": "entryId", "disabled": false, "description": { "content": "(Required) Entry ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "72d2e4d7-ea86-4088-ba45-3d255aa9fd51", "name": "Entry deleted", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "entries", ":entryId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) Entry ID", "type": "text/plain" }, "type": "any", "value": "", "key": "entryId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "045a736f-d958-4880-92fc-9f278a505eb8", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "entries", ":entryId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) Entry ID", "type": "text/plain" }, "type": "any", "value": "", "key": "entryId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ef443c32-c6c6-4881-8745-19552a3b2a81", "name": "Authenticated user is missing the `EDITAR_TARIFAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "entries", ":entryId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) Entry ID", "type": "text/plain" }, "type": "any", "value": "", "key": "entryId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "74717fd7-0252-403c-a0a9-27256fb2d59e", "name": "Price list or entry not found", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "entries", ":entryId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) Entry ID", "type": "text/plain" }, "type": "any", "value": "", "key": "entryId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6549e6ce-b621-483a-8707-a0cc86ed5944", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "entries", ":entryId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) Entry ID", "type": "text/plain" }, "type": "any", "value": "", "key": "entryId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "f32030e3-cfa1-4363-9123-52c7a8900e51", "name": "List price list entries", "request": { "name": "List price list entries", "description": { "content": "Paginated entries (per-product prices and discount rules) of one price list. Product entries carry `productId`; discount rules carry `ruleOrder` plus the category/brand/group/campaign scope. Filter rules with `ruleOrder=notnull=''`, combo scope with `comboConditionId==7`.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "price-lists", ":id", "entries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "id:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "f8612ef6-e39a-4a8c-9ff0-ad9884528f73", "name": "Page of entries", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "entries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "id:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7e827594-2e3c-4929-bbb7-a473580223c3", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "entries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "id:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8c26bc25-5e92-4e19-9b00-2e1204bde32b", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "entries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "id:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "523d6d0f-1b49-4caf-b3fc-f48796223e2c", "name": "Authenticated user is missing the `VER_TARIFAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "entries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "id:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "642bbe7a-71ab-42c9-b8a8-3d17355fba9d", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "entries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "id:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c6c34a7f-117c-45b4-b2af-f199ad23e0e8", "name": "Create price list entry", "request": { "name": "Create price list entry", "description": { "content": "Creates one per-product entry. Requires `productId` and a value: `price` (finalPrice=true), `discountPercent` (finalPrice=false) or `factor` (TBF).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "price-lists", ":id", "entries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"productId\": \"\",\n \"reference\": \"\",\n \"price\": \"\",\n \"discountPercent\": \"\",\n \"factor\": \"\",\n \"finalPrice\": \"\",\n \"vatIncluded\": \"\",\n \"comboConditionId\": \"\",\n \"categoryId\": \"\",\n \"brandId\": \"\",\n \"groupId\": \"\",\n \"campaignId\": \"\",\n \"counterpartyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "b7f9d2d2-969a-46fc-ac0a-314dc894ff0e", "name": "Entry created", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "entries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"productId\": \"\",\n \"reference\": \"\",\n \"price\": \"\",\n \"discountPercent\": \"\",\n \"factor\": \"\",\n \"finalPrice\": \"\",\n \"vatIncluded\": \"\",\n \"comboConditionId\": \"\",\n \"categoryId\": \"\",\n \"brandId\": \"\",\n \"groupId\": \"\",\n \"campaignId\": \"\",\n \"counterpartyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"priceListId\": \"\",\n \"priceListType\": \"DTO\",\n \"productId\": \"\",\n \"productName\": \"\",\n \"productReference\": \"\",\n \"reference\": \"\",\n \"price\": \"\",\n \"discountPercent\": \"\",\n \"factor\": \"\",\n \"finalPrice\": \"\",\n \"vatIncluded\": \"\",\n \"forSales\": \"\",\n \"comboConditionId\": \"\",\n \"ruleOrder\": \"\",\n \"categoryId\": \"\",\n \"categoryName\": \"\",\n \"brandId\": \"\",\n \"brandName\": \"\",\n \"groupId\": \"\",\n \"groupName\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"counterpartyId\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "56ea9fd6-8723-4b74-a31c-3bcf7bb533f6", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "entries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"productId\": \"\",\n \"reference\": \"\",\n \"price\": \"\",\n \"discountPercent\": \"\",\n \"factor\": \"\",\n \"finalPrice\": \"\",\n \"vatIncluded\": \"\",\n \"comboConditionId\": \"\",\n \"categoryId\": \"\",\n \"brandId\": \"\",\n \"groupId\": \"\",\n \"campaignId\": \"\",\n \"counterpartyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "df013044-aa33-4fcd-a8e9-cda3893a2ad1", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "entries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"productId\": \"\",\n \"reference\": \"\",\n \"price\": \"\",\n \"discountPercent\": \"\",\n \"factor\": \"\",\n \"finalPrice\": \"\",\n \"vatIncluded\": \"\",\n \"comboConditionId\": \"\",\n \"categoryId\": \"\",\n \"brandId\": \"\",\n \"groupId\": \"\",\n \"campaignId\": \"\",\n \"counterpartyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "81513aaf-4ecf-4fb4-a783-6145f9d8cce0", "name": "Authenticated user is missing the `EDITAR_TARIFAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "entries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"productId\": \"\",\n \"reference\": \"\",\n \"price\": \"\",\n \"discountPercent\": \"\",\n \"factor\": \"\",\n \"finalPrice\": \"\",\n \"vatIncluded\": \"\",\n \"comboConditionId\": \"\",\n \"categoryId\": \"\",\n \"brandId\": \"\",\n \"groupId\": \"\",\n \"campaignId\": \"\",\n \"counterpartyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "10d3a760-5641-46ca-b7e9-5caad7d1c958", "name": "Price list not found", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "entries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"productId\": \"\",\n \"reference\": \"\",\n \"price\": \"\",\n \"discountPercent\": \"\",\n \"factor\": \"\",\n \"finalPrice\": \"\",\n \"vatIncluded\": \"\",\n \"comboConditionId\": \"\",\n \"categoryId\": \"\",\n \"brandId\": \"\",\n \"groupId\": \"\",\n \"campaignId\": \"\",\n \"counterpartyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0d56236d-969f-4a8d-a9ec-14ad8a72de14", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "entries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"productId\": \"\",\n \"reference\": \"\",\n \"price\": \"\",\n \"discountPercent\": \"\",\n \"factor\": \"\",\n \"finalPrice\": \"\",\n \"vatIncluded\": \"\",\n \"comboConditionId\": \"\",\n \"categoryId\": \"\",\n \"brandId\": \"\",\n \"groupId\": \"\",\n \"campaignId\": \"\",\n \"counterpartyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "bulk", "description": "", "item": [ { "id": "4c8fe065-d884-4ac5-94ac-fccee1bbf542", "name": "Bulk-assign price list entries", "request": { "name": "Bulk-assign price list entries", "description": { "content": "Set-based price assignment over every product matched by the filters (categories, brands, groups, campaign, price range, description/reference/barcode). Mirrors the legacy 'assign to articles' batch action. Duplicates are de-duplicated server-side. Returns 204 (the operation is set-based; list the entries to see the result).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "price-lists", ":id", "entries", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"action\": \"FACTOR\",\n \"value\": \"\",\n \"vatIncluded\": \"\",\n \"comboConditionId\": \"\",\n \"filters\": {\n \"categoryIds\": [\n \"\",\n \"\"\n ],\n \"brandIds\": [\n \"\",\n \"\"\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ],\n \"campaignId\": \"\",\n \"priceFrom\": \"\",\n \"priceTo\": \"\",\n \"description\": \"\",\n \"reference\": \"\",\n \"barcode\": \"\",\n \"assigned\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "a1cf025f-eb4c-4744-8f8a-f72c3cac40c8", "name": "Bulk assignment executed", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "entries", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"action\": \"FACTOR\",\n \"value\": \"\",\n \"vatIncluded\": \"\",\n \"comboConditionId\": \"\",\n \"filters\": {\n \"categoryIds\": [\n \"\",\n \"\"\n ],\n \"brandIds\": [\n \"\",\n \"\"\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ],\n \"campaignId\": \"\",\n \"priceFrom\": \"\",\n \"priceTo\": \"\",\n \"description\": \"\",\n \"reference\": \"\",\n \"barcode\": \"\",\n \"assigned\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d1c1c9c4-d4c7-4e93-aa3b-794516d719ac", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "entries", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"action\": \"FACTOR\",\n \"value\": \"\",\n \"vatIncluded\": \"\",\n \"comboConditionId\": \"\",\n \"filters\": {\n \"categoryIds\": [\n \"\",\n \"\"\n ],\n \"brandIds\": [\n \"\",\n \"\"\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ],\n \"campaignId\": \"\",\n \"priceFrom\": \"\",\n \"priceTo\": \"\",\n \"description\": \"\",\n \"reference\": \"\",\n \"barcode\": \"\",\n \"assigned\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5b6aee23-390e-4624-a6d5-4d57b17bb7f0", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "entries", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"action\": \"FACTOR\",\n \"value\": \"\",\n \"vatIncluded\": \"\",\n \"comboConditionId\": \"\",\n \"filters\": {\n \"categoryIds\": [\n \"\",\n \"\"\n ],\n \"brandIds\": [\n \"\",\n \"\"\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ],\n \"campaignId\": \"\",\n \"priceFrom\": \"\",\n \"priceTo\": \"\",\n \"description\": \"\",\n \"reference\": \"\",\n \"barcode\": \"\",\n \"assigned\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "726fc055-449b-4362-b517-314f53ecc918", "name": "Authenticated user is missing the `EDITAR_TARIFAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "entries", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"action\": \"FACTOR\",\n \"value\": \"\",\n \"vatIncluded\": \"\",\n \"comboConditionId\": \"\",\n \"filters\": {\n \"categoryIds\": [\n \"\",\n \"\"\n ],\n \"brandIds\": [\n \"\",\n \"\"\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ],\n \"campaignId\": \"\",\n \"priceFrom\": \"\",\n \"priceTo\": \"\",\n \"description\": \"\",\n \"reference\": \"\",\n \"barcode\": \"\",\n \"assigned\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "97f2080f-defe-4e82-93a0-02b3a5fec8e3", "name": "Price list not found", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "entries", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"action\": \"FACTOR\",\n \"value\": \"\",\n \"vatIncluded\": \"\",\n \"comboConditionId\": \"\",\n \"filters\": {\n \"categoryIds\": [\n \"\",\n \"\"\n ],\n \"brandIds\": [\n \"\",\n \"\"\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ],\n \"campaignId\": \"\",\n \"priceFrom\": \"\",\n \"priceTo\": \"\",\n \"description\": \"\",\n \"reference\": \"\",\n \"barcode\": \"\",\n \"assigned\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "631797ee-fc5b-40fc-8c05-c9e71e35a907", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "entries", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"action\": \"FACTOR\",\n \"value\": \"\",\n \"vatIncluded\": \"\",\n \"comboConditionId\": \"\",\n \"filters\": {\n \"categoryIds\": [\n \"\",\n \"\"\n ],\n \"brandIds\": [\n \"\",\n \"\"\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ],\n \"campaignId\": \"\",\n \"priceFrom\": \"\",\n \"priceTo\": \"\",\n \"description\": \"\",\n \"reference\": \"\",\n \"barcode\": \"\",\n \"assigned\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "bulk-delete", "description": "", "item": [ { "id": "326659f9-beb2-432d-aef3-1130e42d46fa", "name": "Bulk-delete price list entries", "request": { "name": "Bulk-delete price list entries", "description": { "content": "Removes every entry matched by the filters (same filter block as the bulk assignment). Returns the number of removed rows.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "price-lists", ":id", "entries", "bulk-delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"action\": \"FACTOR\",\n \"value\": \"\",\n \"vatIncluded\": \"\",\n \"comboConditionId\": \"\",\n \"filters\": {\n \"categoryIds\": [\n \"\",\n \"\"\n ],\n \"brandIds\": [\n \"\",\n \"\"\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ],\n \"campaignId\": \"\",\n \"priceFrom\": \"\",\n \"priceTo\": \"\",\n \"description\": \"\",\n \"reference\": \"\",\n \"barcode\": \"\",\n \"assigned\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "60c3e4d6-300e-4df9-bc30-b93a9c30453a", "name": "Entries removed", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "entries", "bulk-delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"action\": \"FACTOR\",\n \"value\": \"\",\n \"vatIncluded\": \"\",\n \"comboConditionId\": \"\",\n \"filters\": {\n \"categoryIds\": [\n \"\",\n \"\"\n ],\n \"brandIds\": [\n \"\",\n \"\"\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ],\n \"campaignId\": \"\",\n \"priceFrom\": \"\",\n \"priceTo\": \"\",\n \"description\": \"\",\n \"reference\": \"\",\n \"barcode\": \"\",\n \"assigned\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"removed\": \"\",\n \"created\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "322a9280-886f-4d96-8e1a-e937d585807f", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "entries", "bulk-delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"action\": \"FACTOR\",\n \"value\": \"\",\n \"vatIncluded\": \"\",\n \"comboConditionId\": \"\",\n \"filters\": {\n \"categoryIds\": [\n \"\",\n \"\"\n ],\n \"brandIds\": [\n \"\",\n \"\"\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ],\n \"campaignId\": \"\",\n \"priceFrom\": \"\",\n \"priceTo\": \"\",\n \"description\": \"\",\n \"reference\": \"\",\n \"barcode\": \"\",\n \"assigned\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "135d4ce7-2d2d-42c9-8867-2c16f976045d", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "entries", "bulk-delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"action\": \"FACTOR\",\n \"value\": \"\",\n \"vatIncluded\": \"\",\n \"comboConditionId\": \"\",\n \"filters\": {\n \"categoryIds\": [\n \"\",\n \"\"\n ],\n \"brandIds\": [\n \"\",\n \"\"\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ],\n \"campaignId\": \"\",\n \"priceFrom\": \"\",\n \"priceTo\": \"\",\n \"description\": \"\",\n \"reference\": \"\",\n \"barcode\": \"\",\n \"assigned\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "017e7fb2-c62c-4d86-89ef-c37c6d4fdf0b", "name": "Authenticated user is missing the `EDITAR_TARIFAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "entries", "bulk-delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"action\": \"FACTOR\",\n \"value\": \"\",\n \"vatIncluded\": \"\",\n \"comboConditionId\": \"\",\n \"filters\": {\n \"categoryIds\": [\n \"\",\n \"\"\n ],\n \"brandIds\": [\n \"\",\n \"\"\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ],\n \"campaignId\": \"\",\n \"priceFrom\": \"\",\n \"priceTo\": \"\",\n \"description\": \"\",\n \"reference\": \"\",\n \"barcode\": \"\",\n \"assigned\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5fb80575-7c87-4ddd-a47b-12578c460588", "name": "Price list not found", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "entries", "bulk-delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"action\": \"FACTOR\",\n \"value\": \"\",\n \"vatIncluded\": \"\",\n \"comboConditionId\": \"\",\n \"filters\": {\n \"categoryIds\": [\n \"\",\n \"\"\n ],\n \"brandIds\": [\n \"\",\n \"\"\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ],\n \"campaignId\": \"\",\n \"priceFrom\": \"\",\n \"priceTo\": \"\",\n \"description\": \"\",\n \"reference\": \"\",\n \"barcode\": \"\",\n \"assigned\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0acd1ce3-d57e-411c-adf0-40f4bb183869", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "entries", "bulk-delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"action\": \"FACTOR\",\n \"value\": \"\",\n \"vatIncluded\": \"\",\n \"comboConditionId\": \"\",\n \"filters\": {\n \"categoryIds\": [\n \"\",\n \"\"\n ],\n \"brandIds\": [\n \"\",\n \"\"\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ],\n \"campaignId\": \"\",\n \"priceFrom\": \"\",\n \"priceTo\": \"\",\n \"description\": \"\",\n \"reference\": \"\",\n \"barcode\": \"\",\n \"assigned\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "combo-conditions", "description": "", "item": [ { "name": "{conditionId}", "description": "", "item": [ { "id": "65d78f0c-7d2c-4fa8-9711-8770674e1226", "name": "Update price list combo condition", "request": { "name": "Update price list combo condition", "description": { "content": "Updates name, quantity, price/discount and VAT flags of a combo condition. The purchase/sale side is immutable.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "price-lists", ":id", "combo-conditions", ":conditionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" } }, { "type": "any", "value": "", "key": "conditionId", "disabled": false, "description": { "content": "(Required) Combo condition ID", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"purchaseCondition\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"discountPercent\": \"\",\n \"finalPrice\": \"\",\n \"vatIncluded\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "f3ad044c-e5c9-4735-9f5f-276507aa0d48", "name": "Combo condition updated", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "combo-conditions", ":conditionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) Combo condition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "conditionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"purchaseCondition\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"discountPercent\": \"\",\n \"finalPrice\": \"\",\n \"vatIncluded\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"priceListId\": \"\",\n \"name\": \"\",\n \"purchaseCondition\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"discountPercent\": \"\",\n \"finalPrice\": \"\",\n \"vatIncluded\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7b51e417-8a3d-424d-ad97-cba7ed0d49a1", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "combo-conditions", ":conditionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) Combo condition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "conditionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"purchaseCondition\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"discountPercent\": \"\",\n \"finalPrice\": \"\",\n \"vatIncluded\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "657d145f-7151-442f-b9cd-805f3a35098e", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "combo-conditions", ":conditionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) Combo condition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "conditionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"purchaseCondition\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"discountPercent\": \"\",\n \"finalPrice\": \"\",\n \"vatIncluded\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "79bd0004-33fe-41c6-81a9-e0b6460c57e4", "name": "Authenticated user is missing the `EDITAR_TARIFAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "combo-conditions", ":conditionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) Combo condition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "conditionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"purchaseCondition\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"discountPercent\": \"\",\n \"finalPrice\": \"\",\n \"vatIncluded\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8ed64d2e-cc5d-4bee-90b0-10666ba9030f", "name": "Price list or combo condition not found", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "combo-conditions", ":conditionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) Combo condition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "conditionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"purchaseCondition\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"discountPercent\": \"\",\n \"finalPrice\": \"\",\n \"vatIncluded\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5898cd19-0ddf-4713-97ef-62920096c977", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "combo-conditions", ":conditionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) Combo condition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "conditionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"purchaseCondition\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"discountPercent\": \"\",\n \"finalPrice\": \"\",\n \"vatIncluded\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5e0be112-7e29-45d4-96be-0b71d0c4c8af", "name": "Delete price list combo condition", "request": { "name": "Delete price list combo condition", "description": { "content": "Deletes a combo condition. Fails when the condition is referenced by documents already invoiced with the combo.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "price-lists", ":id", "combo-conditions", ":conditionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" } }, { "type": "any", "value": "", "key": "conditionId", "disabled": false, "description": { "content": "(Required) Combo condition ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "27805276-e5c8-4b74-b6cf-60ae3fd66cde", "name": "Combo condition deleted", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "combo-conditions", ":conditionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) Combo condition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "conditionId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d037744e-f3a2-4737-b820-4a4bbca2e748", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "combo-conditions", ":conditionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) Combo condition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "conditionId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f2393f49-c61e-4bbc-86f2-2f2361fac61e", "name": "Authenticated user is missing the `EDITAR_TARIFAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "combo-conditions", ":conditionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) Combo condition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "conditionId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ac4abc9f-ae12-47ce-b0b4-5f8f5fb3f9c4", "name": "Price list or combo condition not found", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "combo-conditions", ":conditionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) Combo condition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "conditionId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e3e6b244-8719-4f71-a1be-109c28ec03b5", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "combo-conditions", ":conditionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) Combo condition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "conditionId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "5c6e1ee1-9aec-4599-a034-cc5a39c3f458", "name": "List price list combo conditions", "request": { "name": "List price list combo conditions", "description": { "content": "Combo conditions of a COM price list: purchase requirements (`purchaseCondition=true`) and applied discounts (`purchaseCondition=false`).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "price-lists", ":id", "combo-conditions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "d01a64f6-57ab-4ac9-89f9-86c4c7cb3112", "name": "Combo conditions", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "combo-conditions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"priceListId\": \"\",\n \"name\": \"\",\n \"purchaseCondition\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"discountPercent\": \"\",\n \"finalPrice\": \"\",\n \"vatIncluded\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7ef56b69-294b-445d-91d2-30f69a4161a6", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "combo-conditions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d024ecbb-0e02-4967-9b34-e7c2c6270de4", "name": "Authenticated user is missing the `VER_TARIFAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "combo-conditions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2f56f245-215e-439c-b095-6004188c9836", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "combo-conditions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1b8b7221-e0ab-45a8-bb78-1ddc76bf24ba", "name": "Create price list combo condition", "request": { "name": "Create price list combo condition", "description": { "content": "Adds a combo condition to a COM price list. Requires `purchaseCondition`; the server assigns a default name (Art├¡culo N / Regalo N) when none is provided.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "price-lists", ":id", "combo-conditions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"purchaseCondition\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"discountPercent\": \"\",\n \"finalPrice\": \"\",\n \"vatIncluded\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "51ff19aa-5635-49a3-8815-294be17285a6", "name": "Combo condition created", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "combo-conditions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"purchaseCondition\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"discountPercent\": \"\",\n \"finalPrice\": \"\",\n \"vatIncluded\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"priceListId\": \"\",\n \"name\": \"\",\n \"purchaseCondition\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"discountPercent\": \"\",\n \"finalPrice\": \"\",\n \"vatIncluded\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8a53ed14-bab6-4140-8c47-84f33d1ab7bd", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "combo-conditions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"purchaseCondition\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"discountPercent\": \"\",\n \"finalPrice\": \"\",\n \"vatIncluded\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b590dca4-6b52-49c7-84c8-3c915ee618b2", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "combo-conditions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"purchaseCondition\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"discountPercent\": \"\",\n \"finalPrice\": \"\",\n \"vatIncluded\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fdce7de7-6e84-4715-8f16-50e28a376422", "name": "Authenticated user is missing the `EDITAR_TARIFAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "combo-conditions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"purchaseCondition\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"discountPercent\": \"\",\n \"finalPrice\": \"\",\n \"vatIncluded\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9836fc42-32d7-42de-b21f-ec578241f066", "name": "Price list not found", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "combo-conditions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"purchaseCondition\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"discountPercent\": \"\",\n \"finalPrice\": \"\",\n \"vatIncluded\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bb0ae662-2479-48ea-a87b-5922b8743f00", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "combo-conditions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"purchaseCondition\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"discountPercent\": \"\",\n \"finalPrice\": \"\",\n \"vatIncluded\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "discount-rules", "description": "", "item": [ { "id": "513e8eae-de73-4726-81e6-cdbb57ea6c3a", "name": "Create price list discount rules", "request": { "name": "Create price list discount rules", "description": { "content": "Creates one discount rule per combination of the provided category/brand/group lists, optionally scoped to a campaign or a combo condition. Pre-existing rules with the same scope are replaced; the response reports created and removed counts. Rules are listed through `GET /entries?filter=ruleOrder=notnull=''` and removed through `DELETE /discount-rules/{ruleOrder}`.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "price-lists", ":id", "discount-rules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"action\": \"FACTOR\",\n \"value\": \"\",\n \"vatIncluded\": \"\",\n \"comboConditionId\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ],\n \"brandIds\": [\n \"\",\n \"\"\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ],\n \"campaignId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "bc45775a-9059-491e-b0b8-056b35a16d26", "name": "Rules created", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "discount-rules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"action\": \"FACTOR\",\n \"value\": \"\",\n \"vatIncluded\": \"\",\n \"comboConditionId\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ],\n \"brandIds\": [\n \"\",\n \"\"\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ],\n \"campaignId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"removed\": \"\",\n \"created\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "44a82206-016e-482d-bfc0-6a6190bf28d2", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "discount-rules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"action\": \"FACTOR\",\n \"value\": \"\",\n \"vatIncluded\": \"\",\n \"comboConditionId\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ],\n \"brandIds\": [\n \"\",\n \"\"\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ],\n \"campaignId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e19a4879-b7f9-4a2f-ad2c-ab387a605566", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "discount-rules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"action\": \"FACTOR\",\n \"value\": \"\",\n \"vatIncluded\": \"\",\n \"comboConditionId\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ],\n \"brandIds\": [\n \"\",\n \"\"\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ],\n \"campaignId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3898ed83-661c-41bc-8c25-3e77c72d5ef1", "name": "Authenticated user is missing the `EDITAR_TARIFAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "discount-rules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"action\": \"FACTOR\",\n \"value\": \"\",\n \"vatIncluded\": \"\",\n \"comboConditionId\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ],\n \"brandIds\": [\n \"\",\n \"\"\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ],\n \"campaignId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9a762836-c901-4367-abf9-2c7fea1556d1", "name": "Price list not found", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "discount-rules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"action\": \"FACTOR\",\n \"value\": \"\",\n \"vatIncluded\": \"\",\n \"comboConditionId\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ],\n \"brandIds\": [\n \"\",\n \"\"\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ],\n \"campaignId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "727560a9-6056-42e9-aa0b-4896e906d347", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "discount-rules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"action\": \"FACTOR\",\n \"value\": \"\",\n \"vatIncluded\": \"\",\n \"comboConditionId\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ],\n \"brandIds\": [\n \"\",\n \"\"\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ],\n \"campaignId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{ruleOrder}", "description": "", "item": [ { "id": "3819ef34-e9f0-48a5-b1be-efe1767083df", "name": "Delete price list discount rule", "request": { "name": "Delete price list discount rule", "description": { "content": "Removes the discount rule identified by its `ruleOrder`, optionally scoped to a combo condition via `comboConditionId`.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "price-lists", ":id", "discount-rules", ":ruleOrder" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Combo condition the rule belongs to (COM price lists)", "type": "text/plain" }, "key": "comboConditionId", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" } }, { "type": "any", "value": "", "key": "ruleOrder", "disabled": false, "description": { "content": "(Required) Rule order (see the `ruleOrder` field of the entries)", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "d9f9c6ff-ac03-4bd0-8304-a22db16c325c", "name": "Rule deleted", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "discount-rules", ":ruleOrder" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Combo condition the rule belongs to (COM price lists)", "type": "text/plain" }, "key": "comboConditionId", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) Rule order (see the `ruleOrder` field of the entries)", "type": "text/plain" }, "type": "any", "value": "", "key": "ruleOrder" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f886a255-ea6d-4f9d-9192-6890e289a5f2", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "discount-rules", ":ruleOrder" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Combo condition the rule belongs to (COM price lists)", "type": "text/plain" }, "key": "comboConditionId", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) Rule order (see the `ruleOrder` field of the entries)", "type": "text/plain" }, "type": "any", "value": "", "key": "ruleOrder" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "dedde07d-71ff-4655-84d6-44eea361827c", "name": "Authenticated user is missing the `EDITAR_TARIFAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "discount-rules", ":ruleOrder" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Combo condition the rule belongs to (COM price lists)", "type": "text/plain" }, "key": "comboConditionId", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) Rule order (see the `ruleOrder` field of the entries)", "type": "text/plain" }, "type": "any", "value": "", "key": "ruleOrder" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "04790fcf-1d19-457f-94f3-2b679d96a19c", "name": "Price list not found", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "discount-rules", ":ruleOrder" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Combo condition the rule belongs to (COM price lists)", "type": "text/plain" }, "key": "comboConditionId", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) Rule order (see the `ruleOrder` field of the entries)", "type": "text/plain" }, "type": "any", "value": "", "key": "ruleOrder" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3f16ef7b-35b1-4463-99f9-807c6ed3b259", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "discount-rules", ":ruleOrder" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Combo condition the rule belongs to (COM price lists)", "type": "text/plain" }, "key": "comboConditionId", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) Rule order (see the `ruleOrder` field of the entries)", "type": "text/plain" }, "type": "any", "value": "", "key": "ruleOrder" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "valuation", "description": "", "item": [ { "id": "26af033a-87e2-4da3-8f4b-fa5f612c675d", "name": "Get price list stock valuation", "request": { "name": "Get price list stock valuation", "description": { "content": "Values the on-hand stock of a branch for every product covered by the price list: units, purchase value, base sale value and the sale value after applying this price list. Mirrors the 'Valoraci├│n' panel of the legacy dialog.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "price-lists", ":id", "valuation" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Branch (sucursal) to value", "type": "text/plain" }, "key": "warehouseId", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "2d7848f4-7bdc-41c1-906f-cc85cc4c76e8", "name": "Valuation computed", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "valuation" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Branch (sucursal) to value", "type": "text/plain" }, "key": "warehouseId", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"warehouseId\": \"\",\n \"units\": \"\",\n \"purchaseValue\": \"\",\n \"baseSaleValue\": \"\",\n \"saleValue\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ce1e6588-3675-4c15-8960-90c1010c17fa", "name": "Missing warehouseId", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "valuation" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Branch (sucursal) to value", "type": "text/plain" }, "key": "warehouseId", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4eb915eb-639d-45e8-8f2d-4cef80abd2a7", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "valuation" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Branch (sucursal) to value", "type": "text/plain" }, "key": "warehouseId", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f7a7e0dd-bdcb-47f4-be77-5b4fdeac1789", "name": "Authenticated user is missing the `VER_TARIFAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "valuation" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Branch (sucursal) to value", "type": "text/plain" }, "key": "warehouseId", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c974e848-cd6d-42e1-93d8-c70f5b061bb1", "name": "Price list not found", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "valuation" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Branch (sucursal) to value", "type": "text/plain" }, "key": "warehouseId", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "329424ab-e0cb-419b-bd1b-ec19558ab2bf", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", ":id", "valuation" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Branch (sucursal) to value", "type": "text/plain" }, "key": "warehouseId", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Price list ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "id": "198e94d1-a2ca-4d0e-8242-05c753b7da85", "name": "List price lists", "request": { "name": "List price lists", "description": { "content": "Returns a paginated list of price lists with envelope `{data, totalCount, skip, limit, hasMore}`. Filter by kind with `priceListType==TB` (TB, TBF, DTO, COM), by side with `forSales==true` and by state with `active==true` / `draft==false`. Limit is capped at 200; skip is clamped to >= 0.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "price-lists" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "d1dda8dc-9025-48a2-9ecb-fecf40fa06ce", "name": "Page of price lists", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6ed23057-40bd-4431-b84e-45b5a7d0b7cf", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b455f74f-ec62-4cab-b1a7-65ed7521c523", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "06d1ed93-8ef8-4172-8263-2a2427913f7e", "name": "Authenticated user is missing the `VER_TARIFAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c6e34fa9-a73a-46f4-8e19-460214b8499c", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "52b28908-e988-43d1-a59c-7cf973e42e95", "name": "Create price list", "request": { "name": "Create price list", "description": { "content": "Creates a price list directly in finalised state (no draft phase). Prefer `POST /new` when the creation happens through a form that also attaches entries or combo conditions.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "price-lists" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"priceListType\": \"TB\",\n \"enabled\": \"\",\n \"active\": \"\",\n \"forSales\": \"\",\n \"stackable\": \"\",\n \"appliesOnPartialPayment\": \"\",\n \"requiresValues\": \"\",\n \"usesProductBaseValue\": \"\",\n \"priceSourceType\": \"PC\",\n \"effectiveFrom\": \"\",\n \"effectiveTo\": \"\",\n \"currencyCode\": \"\",\n \"companyId\": \"\",\n \"sourcePriceListId\": \"\",\n \"paymentMethodIds\": [\n \"\",\n \"\"\n ],\n \"cardTypes\": [\n \"\",\n \"\"\n ],\n \"branchSchedules\": [\n {\n \"warehouseId\": \"\",\n \"fromDate\": \"\",\n \"toDate\": \"\",\n \"fromTime\": \"\",\n \"toTime\": \"\",\n \"monday\": \"\",\n \"tuesday\": \"\",\n \"wednesday\": \"\",\n \"thursday\": \"\",\n \"friday\": \"\",\n \"saturday\": \"\",\n \"sunday\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"fromDate\": \"\",\n \"toDate\": \"\",\n \"fromTime\": \"\",\n \"toTime\": \"\",\n \"monday\": \"\",\n \"tuesday\": \"\",\n \"wednesday\": \"\",\n \"thursday\": \"\",\n \"friday\": \"\",\n \"saturday\": \"\",\n \"sunday\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "e579abda-08b5-43cf-a9a7-227c5a00c063", "name": "Price list created", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"priceListType\": \"TB\",\n \"enabled\": \"\",\n \"active\": \"\",\n \"forSales\": \"\",\n \"stackable\": \"\",\n \"appliesOnPartialPayment\": \"\",\n \"requiresValues\": \"\",\n \"usesProductBaseValue\": \"\",\n \"priceSourceType\": \"PC\",\n \"effectiveFrom\": \"\",\n \"effectiveTo\": \"\",\n \"currencyCode\": \"\",\n \"companyId\": \"\",\n \"sourcePriceListId\": \"\",\n \"paymentMethodIds\": [\n \"\",\n \"\"\n ],\n \"cardTypes\": [\n \"\",\n \"\"\n ],\n \"branchSchedules\": [\n {\n \"warehouseId\": \"\",\n \"fromDate\": \"\",\n \"toDate\": \"\",\n \"fromTime\": \"\",\n \"toTime\": \"\",\n \"monday\": \"\",\n \"tuesday\": \"\",\n \"wednesday\": \"\",\n \"thursday\": \"\",\n \"friday\": \"\",\n \"saturday\": \"\",\n \"sunday\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"fromDate\": \"\",\n \"toDate\": \"\",\n \"fromTime\": \"\",\n \"toTime\": \"\",\n \"monday\": \"\",\n \"tuesday\": \"\",\n \"wednesday\": \"\",\n \"thursday\": \"\",\n \"friday\": \"\",\n \"saturday\": \"\",\n \"sunday\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"priceListType\": \"DTO\",\n \"enabled\": \"\",\n \"active\": \"\",\n \"draft\": \"\",\n \"forSales\": \"\",\n \"stackable\": \"\",\n \"appliesOnPartialPayment\": \"\",\n \"requiresValues\": \"\",\n \"usesProductBaseValue\": \"\",\n \"priceSourceType\": \"PC\",\n \"blockType\": \"\",\n \"effectiveFrom\": \"\",\n \"effectiveTo\": \"\",\n \"currencyCode\": \"\",\n \"purchaseConditionsCount\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"sourcePriceListId\": \"\",\n \"sourcePriceListName\": \"\",\n \"paymentMethodIds\": [\n \"\",\n \"\"\n ],\n \"cardTypes\": [\n \"\",\n \"\"\n ],\n \"branchSchedules\": [\n {\n \"id\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"fromDate\": \"\",\n \"toDate\": \"\",\n \"fromTime\": \"\",\n \"toTime\": \"\",\n \"monday\": \"\",\n \"tuesday\": \"\",\n \"wednesday\": \"\",\n \"thursday\": \"\",\n \"friday\": \"\",\n \"saturday\": \"\",\n \"sunday\": \"\"\n },\n {\n \"id\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"fromDate\": \"\",\n \"toDate\": \"\",\n \"fromTime\": \"\",\n \"toTime\": \"\",\n \"monday\": \"\",\n \"tuesday\": \"\",\n \"wednesday\": \"\",\n \"thursday\": \"\",\n \"friday\": \"\",\n \"saturday\": \"\",\n \"sunday\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "67b0f847-020d-4fd6-9041-eba1855877a0", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"priceListType\": \"TB\",\n \"enabled\": \"\",\n \"active\": \"\",\n \"forSales\": \"\",\n \"stackable\": \"\",\n \"appliesOnPartialPayment\": \"\",\n \"requiresValues\": \"\",\n \"usesProductBaseValue\": \"\",\n \"priceSourceType\": \"PC\",\n \"effectiveFrom\": \"\",\n \"effectiveTo\": \"\",\n \"currencyCode\": \"\",\n \"companyId\": \"\",\n \"sourcePriceListId\": \"\",\n \"paymentMethodIds\": [\n \"\",\n \"\"\n ],\n \"cardTypes\": [\n \"\",\n \"\"\n ],\n \"branchSchedules\": [\n {\n \"warehouseId\": \"\",\n \"fromDate\": \"\",\n \"toDate\": \"\",\n \"fromTime\": \"\",\n \"toTime\": \"\",\n \"monday\": \"\",\n \"tuesday\": \"\",\n \"wednesday\": \"\",\n \"thursday\": \"\",\n \"friday\": \"\",\n \"saturday\": \"\",\n \"sunday\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"fromDate\": \"\",\n \"toDate\": \"\",\n \"fromTime\": \"\",\n \"toTime\": \"\",\n \"monday\": \"\",\n \"tuesday\": \"\",\n \"wednesday\": \"\",\n \"thursday\": \"\",\n \"friday\": \"\",\n \"saturday\": \"\",\n \"sunday\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "56278359-11e2-41f1-ad75-8fb381fd7452", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"priceListType\": \"TB\",\n \"enabled\": \"\",\n \"active\": \"\",\n \"forSales\": \"\",\n \"stackable\": \"\",\n \"appliesOnPartialPayment\": \"\",\n \"requiresValues\": \"\",\n \"usesProductBaseValue\": \"\",\n \"priceSourceType\": \"PC\",\n \"effectiveFrom\": \"\",\n \"effectiveTo\": \"\",\n \"currencyCode\": \"\",\n \"companyId\": \"\",\n \"sourcePriceListId\": \"\",\n \"paymentMethodIds\": [\n \"\",\n \"\"\n ],\n \"cardTypes\": [\n \"\",\n \"\"\n ],\n \"branchSchedules\": [\n {\n \"warehouseId\": \"\",\n \"fromDate\": \"\",\n \"toDate\": \"\",\n \"fromTime\": \"\",\n \"toTime\": \"\",\n \"monday\": \"\",\n \"tuesday\": \"\",\n \"wednesday\": \"\",\n \"thursday\": \"\",\n \"friday\": \"\",\n \"saturday\": \"\",\n \"sunday\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"fromDate\": \"\",\n \"toDate\": \"\",\n \"fromTime\": \"\",\n \"toTime\": \"\",\n \"monday\": \"\",\n \"tuesday\": \"\",\n \"wednesday\": \"\",\n \"thursday\": \"\",\n \"friday\": \"\",\n \"saturday\": \"\",\n \"sunday\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ddc01088-1efa-4744-abf8-3976a26c47be", "name": "Authenticated user is missing the `CREAR_TARIFAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"priceListType\": \"TB\",\n \"enabled\": \"\",\n \"active\": \"\",\n \"forSales\": \"\",\n \"stackable\": \"\",\n \"appliesOnPartialPayment\": \"\",\n \"requiresValues\": \"\",\n \"usesProductBaseValue\": \"\",\n \"priceSourceType\": \"PC\",\n \"effectiveFrom\": \"\",\n \"effectiveTo\": \"\",\n \"currencyCode\": \"\",\n \"companyId\": \"\",\n \"sourcePriceListId\": \"\",\n \"paymentMethodIds\": [\n \"\",\n \"\"\n ],\n \"cardTypes\": [\n \"\",\n \"\"\n ],\n \"branchSchedules\": [\n {\n \"warehouseId\": \"\",\n \"fromDate\": \"\",\n \"toDate\": \"\",\n \"fromTime\": \"\",\n \"toTime\": \"\",\n \"monday\": \"\",\n \"tuesday\": \"\",\n \"wednesday\": \"\",\n \"thursday\": \"\",\n \"friday\": \"\",\n \"saturday\": \"\",\n \"sunday\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"fromDate\": \"\",\n \"toDate\": \"\",\n \"fromTime\": \"\",\n \"toTime\": \"\",\n \"monday\": \"\",\n \"tuesday\": \"\",\n \"wednesday\": \"\",\n \"thursday\": \"\",\n \"friday\": \"\",\n \"saturday\": \"\",\n \"sunday\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c0f0f569-15a5-4881-be5f-0618ac2a6b06", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"priceListType\": \"TB\",\n \"enabled\": \"\",\n \"active\": \"\",\n \"forSales\": \"\",\n \"stackable\": \"\",\n \"appliesOnPartialPayment\": \"\",\n \"requiresValues\": \"\",\n \"usesProductBaseValue\": \"\",\n \"priceSourceType\": \"PC\",\n \"effectiveFrom\": \"\",\n \"effectiveTo\": \"\",\n \"currencyCode\": \"\",\n \"companyId\": \"\",\n \"sourcePriceListId\": \"\",\n \"paymentMethodIds\": [\n \"\",\n \"\"\n ],\n \"cardTypes\": [\n \"\",\n \"\"\n ],\n \"branchSchedules\": [\n {\n \"warehouseId\": \"\",\n \"fromDate\": \"\",\n \"toDate\": \"\",\n \"fromTime\": \"\",\n \"toTime\": \"\",\n \"monday\": \"\",\n \"tuesday\": \"\",\n \"wednesday\": \"\",\n \"thursday\": \"\",\n \"friday\": \"\",\n \"saturday\": \"\",\n \"sunday\": \"\"\n },\n {\n \"warehouseId\": \"\",\n \"fromDate\": \"\",\n \"toDate\": \"\",\n \"fromTime\": \"\",\n \"toTime\": \"\",\n \"monday\": \"\",\n \"tuesday\": \"\",\n \"wednesday\": \"\",\n \"thursday\": \"\",\n \"friday\": \"\",\n \"saturday\": \"\",\n \"sunday\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "new", "description": "", "item": [ { "id": "23086bfe-2543-4c37-8d9c-a40abbce31ea", "name": "Create price list draft", "request": { "name": "Create price list draft", "description": { "content": "PERSISTS a new price list in draft mode (`draft=true`) and returns it with a real `id` ÔÇö unlike the non-persisting `/new` of other resources. The row must exist so entries, discount rules and combo conditions can be attached while the form is being filled; the first PUT finalises the draft. Hints: `priceListType` (required ÔÇö TB, TBF, DTO or COM), `forSales` (default true), `companyId` (defaults to the user's current company), `copyFromId` (duplicates the source price list including entries and combo conditions), `name`, `code`. Delete the draft with the regular DELETE to cancel.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "price-lists", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "0a891ef7-db85-43e4-aeae-399895c336c8", "name": "Draft persisted", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"priceListType\": \"DTO\",\n \"enabled\": \"\",\n \"active\": \"\",\n \"draft\": \"\",\n \"forSales\": \"\",\n \"stackable\": \"\",\n \"appliesOnPartialPayment\": \"\",\n \"requiresValues\": \"\",\n \"usesProductBaseValue\": \"\",\n \"priceSourceType\": \"PC\",\n \"blockType\": \"\",\n \"effectiveFrom\": \"\",\n \"effectiveTo\": \"\",\n \"currencyCode\": \"\",\n \"purchaseConditionsCount\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"sourcePriceListId\": \"\",\n \"sourcePriceListName\": \"\",\n \"paymentMethodIds\": [\n \"\",\n \"\"\n ],\n \"cardTypes\": [\n \"\",\n \"\"\n ],\n \"branchSchedules\": [\n {\n \"id\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"fromDate\": \"\",\n \"toDate\": \"\",\n \"fromTime\": \"\",\n \"toTime\": \"\",\n \"monday\": \"\",\n \"tuesday\": \"\",\n \"wednesday\": \"\",\n \"thursday\": \"\",\n \"friday\": \"\",\n \"saturday\": \"\",\n \"sunday\": \"\"\n },\n {\n \"id\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"fromDate\": \"\",\n \"toDate\": \"\",\n \"fromTime\": \"\",\n \"toTime\": \"\",\n \"monday\": \"\",\n \"tuesday\": \"\",\n \"wednesday\": \"\",\n \"thursday\": \"\",\n \"friday\": \"\",\n \"saturday\": \"\",\n \"sunday\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "048290f1-0632-4424-b212-6801119c5bb3", "name": "Invalid hints (missing priceListType, unknown copyFromId, ...)", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5cd72af4-33d1-4b29-b3a7-2bc343265021", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "074fd990-9ac1-40cd-8617-0ee4f7bf3181", "name": "Authenticated user is missing the `CREAR_TARIFAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3ab8fce8-0131-40eb-b11f-484c553b5860", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "price-lists", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "payment-terms", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "9d9f596a-0d8e-4e65-b69a-5505296c642d", "name": "Get payment term by ID", "request": { "name": "Get payment term by ID", "description": { "content": "Returns a single payment term by its primary key. The response carries a strong `ETag` header with the current version.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "payment-terms", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Payment term ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "8939658c-f24b-45b4-86a3-d81c32b21c80", "name": "Payment term found", "originalRequest": { "url": { "path": [ "api", "v2", "payment-terms", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment term ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"printText\": \"\",\n \"instalmentCount\": \"\",\n \"firstDueDays\": \"\",\n \"intervalDays\": \"\",\n \"paymentDay1\": \"\",\n \"paymentDay2\": \"\",\n \"calendarDays\": \"\",\n \"useNextPaymentDay\": \"\",\n \"bankName\": \"\",\n \"bankAccount\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e23d716a-617d-4a15-b33e-c4c74bb0e648", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "payment-terms", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment term ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "150028fd-9977-4ae3-bf4c-33944cfcf848", "name": "Authenticated user is missing the `VER_CONDICIONESPAGO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "payment-terms", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment term ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5bb8e25c-d582-40f8-8947-4a8ea66a2120", "name": "Payment term not found", "originalRequest": { "url": { "path": [ "api", "v2", "payment-terms", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment term ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "defb0a4f-9c1c-4d50-a04f-12f04db3c49c", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "payment-terms", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment term ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dd89799e-a432-4010-be6e-d9d08576c34c", "name": "Update payment term", "request": { "name": "Update payment term", "description": { "content": "Full replacement of an existing payment term. Send the `If-Match` header with the current ETag for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "payment-terms", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Payment term ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"printText\": \"\",\n \"instalmentCount\": \"\",\n \"firstDueDays\": \"\",\n \"intervalDays\": \"\",\n \"paymentDay1\": \"\",\n \"paymentDay2\": \"\",\n \"calendarDays\": \"\",\n \"useNextPaymentDay\": \"\",\n \"bankName\": \"\",\n \"bankAccount\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"paymentMethodId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "69606c92-7a2c-46a7-a160-0276e7278921", "name": "Payment term updated", "originalRequest": { "url": { "path": [ "api", "v2", "payment-terms", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment term ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"printText\": \"\",\n \"instalmentCount\": \"\",\n \"firstDueDays\": \"\",\n \"intervalDays\": \"\",\n \"paymentDay1\": \"\",\n \"paymentDay2\": \"\",\n \"calendarDays\": \"\",\n \"useNextPaymentDay\": \"\",\n \"bankName\": \"\",\n \"bankAccount\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"paymentMethodId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"printText\": \"\",\n \"instalmentCount\": \"\",\n \"firstDueDays\": \"\",\n \"intervalDays\": \"\",\n \"paymentDay1\": \"\",\n \"paymentDay2\": \"\",\n \"calendarDays\": \"\",\n \"useNextPaymentDay\": \"\",\n \"bankName\": \"\",\n \"bankAccount\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b3ee41af-ca2e-4082-bb6f-7eed09d451ac", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "payment-terms", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment term ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"printText\": \"\",\n \"instalmentCount\": \"\",\n \"firstDueDays\": \"\",\n \"intervalDays\": \"\",\n \"paymentDay1\": \"\",\n \"paymentDay2\": \"\",\n \"calendarDays\": \"\",\n \"useNextPaymentDay\": \"\",\n \"bankName\": \"\",\n \"bankAccount\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"paymentMethodId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "abd5eaf1-3f3c-44c4-a71b-be2d0e3a93a6", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "payment-terms", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment term ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"printText\": \"\",\n \"instalmentCount\": \"\",\n \"firstDueDays\": \"\",\n \"intervalDays\": \"\",\n \"paymentDay1\": \"\",\n \"paymentDay2\": \"\",\n \"calendarDays\": \"\",\n \"useNextPaymentDay\": \"\",\n \"bankName\": \"\",\n \"bankAccount\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"paymentMethodId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bd8baf30-5401-41af-a789-e12739f5b061", "name": "Authenticated user is missing the `EDITAR_CONDICIONESPAGO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "payment-terms", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment term ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"printText\": \"\",\n \"instalmentCount\": \"\",\n \"firstDueDays\": \"\",\n \"intervalDays\": \"\",\n \"paymentDay1\": \"\",\n \"paymentDay2\": \"\",\n \"calendarDays\": \"\",\n \"useNextPaymentDay\": \"\",\n \"bankName\": \"\",\n \"bankAccount\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"paymentMethodId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "61c28b5d-abc9-4432-b198-18ef3f0bf212", "name": "Payment term not found", "originalRequest": { "url": { "path": [ "api", "v2", "payment-terms", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment term ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"printText\": \"\",\n \"instalmentCount\": \"\",\n \"firstDueDays\": \"\",\n \"intervalDays\": \"\",\n \"paymentDay1\": \"\",\n \"paymentDay2\": \"\",\n \"calendarDays\": \"\",\n \"useNextPaymentDay\": \"\",\n \"bankName\": \"\",\n \"bankAccount\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"paymentMethodId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "030d9826-02a0-435f-8a07-6fd7e4c462a8", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "payment-terms", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment term ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"printText\": \"\",\n \"instalmentCount\": \"\",\n \"firstDueDays\": \"\",\n \"intervalDays\": \"\",\n \"paymentDay1\": \"\",\n \"paymentDay2\": \"\",\n \"calendarDays\": \"\",\n \"useNextPaymentDay\": \"\",\n \"bankName\": \"\",\n \"bankAccount\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"paymentMethodId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5e25a28c-88bb-45a0-ace5-9851fb16bf64", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "payment-terms", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment term ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"printText\": \"\",\n \"instalmentCount\": \"\",\n \"firstDueDays\": \"\",\n \"intervalDays\": \"\",\n \"paymentDay1\": \"\",\n \"paymentDay2\": \"\",\n \"calendarDays\": \"\",\n \"useNextPaymentDay\": \"\",\n \"bankName\": \"\",\n \"bankAccount\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"paymentMethodId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "404f908d-93cc-4e0d-aba5-650249360caa", "name": "Delete payment term", "request": { "name": "Delete payment term", "description": { "content": "Deletes a payment term. Send the `If-Match` header with the current ETag for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "payment-terms", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Payment term ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "c52d529e-9ca3-4a12-af8c-322ae273669c", "name": "Payment term deleted", "originalRequest": { "url": { "path": [ "api", "v2", "payment-terms", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment term ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "eb448d7b-2efb-4c4e-a0c7-03eb96e3733b", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "payment-terms", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment term ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8a0435d7-9ca8-480e-bc6c-ac2b1192283d", "name": "Authenticated user is missing the `BORRAR_CONDICIONESPAGO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "payment-terms", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment term ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "42d1fafe-e7bc-4ddc-805f-4be04e6c16ea", "name": "Payment term not found", "originalRequest": { "url": { "path": [ "api", "v2", "payment-terms", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment term ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e0a302fa-3958-440f-8ce2-1d2707696b14", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "payment-terms", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment term ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6c306134-211f-4174-bedc-729e4e7b7c61", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "payment-terms", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment term ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b29f37eb-a6c9-40f8-94cc-e9a5931f612b", "name": "Merge-patch payment term", "request": { "name": "Merge-patch payment term", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "payment-terms", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Payment term ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "32ff4f27-3036-4c97-a371-8de3e4867706", "name": "Payment term patched", "originalRequest": { "url": { "path": [ "api", "v2", "payment-terms", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment term ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"printText\": \"\",\n \"instalmentCount\": \"\",\n \"firstDueDays\": \"\",\n \"intervalDays\": \"\",\n \"paymentDay1\": \"\",\n \"paymentDay2\": \"\",\n \"calendarDays\": \"\",\n \"useNextPaymentDay\": \"\",\n \"bankName\": \"\",\n \"bankAccount\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a6e424e5-83e2-4f35-be15-367423d42be3", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "payment-terms", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment term ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fc0c8c22-8d19-4844-8fbc-d2444d001ecf", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "payment-terms", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment term ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2a59be5e-c173-4156-962e-2d328a6ef362", "name": "Authenticated user is missing the `EDITAR_CONDICIONESPAGO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "payment-terms", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment term ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "43a71ce8-fc57-44a3-8e9e-7f87349fa40d", "name": "Payment term not found", "originalRequest": { "url": { "path": [ "api", "v2", "payment-terms", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment term ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "934b5385-b911-4f13-9572-506c42a15cbb", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "payment-terms", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment term ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d21283c6-293f-46a6-8050-c8b2a149427a", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "payment-terms", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment term ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "8bba35f1-b76a-4d72-8994-0f5249ed42fd", "name": "List payment terms", "request": { "name": "List payment terms", "description": { "content": "Returns a paginated list of payment terms with envelope `{data, totalCount, skip, limit, hasMore}`. Supports optional RSQL `filter`, `sort` (default `lastModifiedAt:desc`), `skip`/`limit` pagination and `modifiedAfter`/`modifiedBefore` bookends.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "payment-terms" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "5e473bcd-45e4-49c8-b996-ec13d78ae245", "name": "Page of payment terms", "originalRequest": { "url": { "path": [ "api", "v2", "payment-terms" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "70bdb3b5-c92a-42ba-8a6d-989b2467bb29", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "payment-terms" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b6c48bbd-57e5-4ed2-bbe8-76a428d3f643", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "payment-terms" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "859417f1-c690-4ea1-a708-cc81bf899b99", "name": "Authenticated user is missing the `VER_CONDICIONESPAGO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "payment-terms" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d3d26eb2-c076-4483-bf6d-c77c9c74762f", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "payment-terms" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "af60239d-ea51-4a26-9ac8-fac254bb966a", "name": "Create payment term", "request": { "name": "Create payment term", "description": { "content": "Creates a new payment term. Business logic runs in the legacy WAR.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "payment-terms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"printText\": \"\",\n \"instalmentCount\": \"\",\n \"firstDueDays\": \"\",\n \"intervalDays\": \"\",\n \"paymentDay1\": \"\",\n \"paymentDay2\": \"\",\n \"calendarDays\": \"\",\n \"useNextPaymentDay\": \"\",\n \"bankName\": \"\",\n \"bankAccount\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"paymentMethodId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "19c494ca-3e62-4a55-a4b9-e5b87c81d75c", "name": "Payment term created", "originalRequest": { "url": { "path": [ "api", "v2", "payment-terms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"printText\": \"\",\n \"instalmentCount\": \"\",\n \"firstDueDays\": \"\",\n \"intervalDays\": \"\",\n \"paymentDay1\": \"\",\n \"paymentDay2\": \"\",\n \"calendarDays\": \"\",\n \"useNextPaymentDay\": \"\",\n \"bankName\": \"\",\n \"bankAccount\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"paymentMethodId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"printText\": \"\",\n \"instalmentCount\": \"\",\n \"firstDueDays\": \"\",\n \"intervalDays\": \"\",\n \"paymentDay1\": \"\",\n \"paymentDay2\": \"\",\n \"calendarDays\": \"\",\n \"useNextPaymentDay\": \"\",\n \"bankName\": \"\",\n \"bankAccount\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7ac51116-7ebb-4f3e-943c-09e5c2c51503", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "payment-terms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"printText\": \"\",\n \"instalmentCount\": \"\",\n \"firstDueDays\": \"\",\n \"intervalDays\": \"\",\n \"paymentDay1\": \"\",\n \"paymentDay2\": \"\",\n \"calendarDays\": \"\",\n \"useNextPaymentDay\": \"\",\n \"bankName\": \"\",\n \"bankAccount\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"paymentMethodId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e4d2248e-6736-467b-969b-79a68ad3cf03", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "payment-terms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"printText\": \"\",\n \"instalmentCount\": \"\",\n \"firstDueDays\": \"\",\n \"intervalDays\": \"\",\n \"paymentDay1\": \"\",\n \"paymentDay2\": \"\",\n \"calendarDays\": \"\",\n \"useNextPaymentDay\": \"\",\n \"bankName\": \"\",\n \"bankAccount\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"paymentMethodId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "52d0550a-9d01-43c2-ad33-451f5e5b0651", "name": "Authenticated user is missing the `CREAR_CONDICIONESPAGO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "payment-terms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"printText\": \"\",\n \"instalmentCount\": \"\",\n \"firstDueDays\": \"\",\n \"intervalDays\": \"\",\n \"paymentDay1\": \"\",\n \"paymentDay2\": \"\",\n \"calendarDays\": \"\",\n \"useNextPaymentDay\": \"\",\n \"bankName\": \"\",\n \"bankAccount\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"paymentMethodId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0bda74a0-7906-489d-9d1d-eca9bb58bc8c", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "payment-terms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"printText\": \"\",\n \"instalmentCount\": \"\",\n \"firstDueDays\": \"\",\n \"intervalDays\": \"\",\n \"paymentDay1\": \"\",\n \"paymentDay2\": \"\",\n \"calendarDays\": \"\",\n \"useNextPaymentDay\": \"\",\n \"bankName\": \"\",\n \"bankAccount\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"paymentMethodId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "new", "description": "", "item": [ { "id": "1ed8ad5d-45d3-4505-a5c0-63603ea0fcd3", "name": "Prototype payment term for a creation form", "request": { "name": "Prototype payment term for a creation form", "description": { "content": "Returns a non-persisted payment term pre-populated with backend defaults (current company, `enabled=true`, one instalment). Optional JSON hints: `companyId`, `copyFromId`. Call `POST /api/v2/payment-terms` to persist.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "payment-terms", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "275de7cc-1983-4783-9e73-e270eadc5fed", "name": "Payment term prototype with defaults", "originalRequest": { "url": { "path": [ "api", "v2", "payment-terms", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"printText\": \"\",\n \"instalmentCount\": \"\",\n \"firstDueDays\": \"\",\n \"intervalDays\": \"\",\n \"paymentDay1\": \"\",\n \"paymentDay2\": \"\",\n \"calendarDays\": \"\",\n \"useNextPaymentDay\": \"\",\n \"bankName\": \"\",\n \"bankAccount\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "39482a16-1526-4237-9150-f92f012ed11c", "name": "Invalid prepare-create hints", "originalRequest": { "url": { "path": [ "api", "v2", "payment-terms", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "074fb136-27a5-4114-8e54-eee771eb5763", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "payment-terms", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "da72f1b5-0636-4bd7-8325-e9a1576a2355", "name": "Authenticated user is missing the `CREAR_CONDICIONESPAGO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "payment-terms", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "af5c5af8-7fa0-4196-8284-ebff9e41789f", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "payment-terms", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "payment-methods", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "d53d9da5-95c1-432d-8830-5004d0a43823", "name": "Get payment method by ID", "request": { "name": "Get payment method by ID", "description": { "content": "Returns a single payment method by its primary key, including the per-company ledger account mapping (`associatedAccounts`). The response carries a strong `ETag` header with the current version.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "payment-methods", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Payment method ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "09e72054-7e19-4577-a062-7c3642e799cb", "name": "Payment method found", "originalRequest": { "url": { "path": [ "api", "v2", "payment-methods", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment method ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"enabledForRefunds\": \"\",\n \"excludeFromCashClose\": \"\",\n \"internalGesvision\": \"\",\n \"paymentKind\": \"I\",\n \"collectionKind\": \"CP\",\n \"cardTerminal\": \"MN\",\n \"webPosPaymentKind\": \"C\",\n \"sriPaymentMethod\": \"T20\",\n \"olaCardType\": \"T7\",\n \"sapCrPaymentMethod\": \"RT\",\n \"satPaymentMethod\": \"VALUE_8\",\n \"requiresChange\": \"\",\n \"bankMovement\": \"\",\n \"automaticAccountingDate\": \"\",\n \"voucher\": \"\",\n \"voucherValidityDays\": \"\",\n \"promissoryNote\": \"\",\n \"alwaysRefundable\": \"\",\n \"cashKeeper\": \"\",\n \"postToLedger\": \"\",\n \"requiresValidation\": \"\",\n \"askInstalments\": \"\",\n \"subscription\": \"\",\n \"usableForIncoming\": \"\",\n \"usableForOutgoing\": \"\",\n \"taxPct\": \"\",\n \"appliesPaymentTax\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"associatedAccounts\": [\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"accountId\": \"\",\n \"accountCode\": \"\",\n \"accountName\": \"\"\n },\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"accountId\": \"\",\n \"accountCode\": \"\",\n \"accountName\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "77e914d4-0f38-4653-91c7-5f10ff14809f", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "payment-methods", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment method ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "dc80c68c-27be-43aa-b9b0-f82acb2e1ccd", "name": "Authenticated user is missing the `VER_FORMASDEPAGO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "payment-methods", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment method ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b343d198-645d-44ad-bf16-7dc63712ce27", "name": "Payment method not found", "originalRequest": { "url": { "path": [ "api", "v2", "payment-methods", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment method ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9e7a5400-b97f-42b8-88e2-a295c157f0c5", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "payment-methods", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment method ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "190de96a-3823-40e0-a82d-6c9fd4b179b7", "name": "Update payment method", "request": { "name": "Update payment method", "description": { "content": "Full replacement of an existing payment method. Send the `If-Match` header with the current ETag for optimistic concurrency control. `associatedAccounts` follows collection semantics: null leaves the ledger mapping untouched, [] clears it, a non-empty list replaces it.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "payment-methods", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Payment method ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"enabledForRefunds\": \"\",\n \"excludeFromCashClose\": \"\",\n \"internalGesvision\": \"\",\n \"paymentKind\": \"V\",\n \"collectionKind\": \"RI\",\n \"cardTerminal\": \"MN\",\n \"webPosPaymentKind\": \"TC\",\n \"sriPaymentMethod\": \"T3\",\n \"olaCardType\": \"T24\",\n \"sapCrPaymentMethod\": \"SM\",\n \"satPaymentMethod\": \"VALUE_16\",\n \"requiresChange\": \"\",\n \"bankMovement\": \"\",\n \"automaticAccountingDate\": \"\",\n \"voucher\": \"\",\n \"voucherValidityDays\": \"\",\n \"promissoryNote\": \"\",\n \"alwaysRefundable\": \"\",\n \"cashKeeper\": \"\",\n \"postToLedger\": \"\",\n \"requiresValidation\": \"\",\n \"askInstalments\": \"\",\n \"subscription\": \"\",\n \"usableForIncoming\": \"\",\n \"usableForOutgoing\": \"\",\n \"taxPct\": \"\",\n \"companyId\": \"\",\n \"associatedAccounts\": [\n {\n \"companyId\": \"\",\n \"accountId\": \"\"\n },\n {\n \"companyId\": \"\",\n \"accountId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "9c32bdce-9fe8-4bc1-9df9-cb3601447406", "name": "Payment method updated", "originalRequest": { "url": { "path": [ "api", "v2", "payment-methods", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment method ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"enabledForRefunds\": \"\",\n \"excludeFromCashClose\": \"\",\n \"internalGesvision\": \"\",\n \"paymentKind\": \"V\",\n \"collectionKind\": \"RI\",\n \"cardTerminal\": \"MN\",\n \"webPosPaymentKind\": \"TC\",\n \"sriPaymentMethod\": \"T3\",\n \"olaCardType\": \"T24\",\n \"sapCrPaymentMethod\": \"SM\",\n \"satPaymentMethod\": \"VALUE_16\",\n \"requiresChange\": \"\",\n \"bankMovement\": \"\",\n \"automaticAccountingDate\": \"\",\n \"voucher\": \"\",\n \"voucherValidityDays\": \"\",\n \"promissoryNote\": \"\",\n \"alwaysRefundable\": \"\",\n \"cashKeeper\": \"\",\n \"postToLedger\": \"\",\n \"requiresValidation\": \"\",\n \"askInstalments\": \"\",\n \"subscription\": \"\",\n \"usableForIncoming\": \"\",\n \"usableForOutgoing\": \"\",\n \"taxPct\": \"\",\n \"companyId\": \"\",\n \"associatedAccounts\": [\n {\n \"companyId\": \"\",\n \"accountId\": \"\"\n },\n {\n \"companyId\": \"\",\n \"accountId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"enabledForRefunds\": \"\",\n \"excludeFromCashClose\": \"\",\n \"internalGesvision\": \"\",\n \"paymentKind\": \"I\",\n \"collectionKind\": \"CP\",\n \"cardTerminal\": \"MN\",\n \"webPosPaymentKind\": \"C\",\n \"sriPaymentMethod\": \"T20\",\n \"olaCardType\": \"T7\",\n \"sapCrPaymentMethod\": \"RT\",\n \"satPaymentMethod\": \"VALUE_8\",\n \"requiresChange\": \"\",\n \"bankMovement\": \"\",\n \"automaticAccountingDate\": \"\",\n \"voucher\": \"\",\n \"voucherValidityDays\": \"\",\n \"promissoryNote\": \"\",\n \"alwaysRefundable\": \"\",\n \"cashKeeper\": \"\",\n \"postToLedger\": \"\",\n \"requiresValidation\": \"\",\n \"askInstalments\": \"\",\n \"subscription\": \"\",\n \"usableForIncoming\": \"\",\n \"usableForOutgoing\": \"\",\n \"taxPct\": \"\",\n \"appliesPaymentTax\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"associatedAccounts\": [\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"accountId\": \"\",\n \"accountCode\": \"\",\n \"accountName\": \"\"\n },\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"accountId\": \"\",\n \"accountCode\": \"\",\n \"accountName\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "13cc1000-bf2b-4918-9f8c-1028326f75d0", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "payment-methods", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment method ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"enabledForRefunds\": \"\",\n \"excludeFromCashClose\": \"\",\n \"internalGesvision\": \"\",\n \"paymentKind\": \"V\",\n \"collectionKind\": \"RI\",\n \"cardTerminal\": \"MN\",\n \"webPosPaymentKind\": \"TC\",\n \"sriPaymentMethod\": \"T3\",\n \"olaCardType\": \"T24\",\n \"sapCrPaymentMethod\": \"SM\",\n \"satPaymentMethod\": \"VALUE_16\",\n \"requiresChange\": \"\",\n \"bankMovement\": \"\",\n \"automaticAccountingDate\": \"\",\n \"voucher\": \"\",\n \"voucherValidityDays\": \"\",\n \"promissoryNote\": \"\",\n \"alwaysRefundable\": \"\",\n \"cashKeeper\": \"\",\n \"postToLedger\": \"\",\n \"requiresValidation\": \"\",\n \"askInstalments\": \"\",\n \"subscription\": \"\",\n \"usableForIncoming\": \"\",\n \"usableForOutgoing\": \"\",\n \"taxPct\": \"\",\n \"companyId\": \"\",\n \"associatedAccounts\": [\n {\n \"companyId\": \"\",\n \"accountId\": \"\"\n },\n {\n \"companyId\": \"\",\n \"accountId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d01e1b8c-3a2a-4d95-a36c-9da2a41ccc52", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "payment-methods", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment method ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"enabledForRefunds\": \"\",\n \"excludeFromCashClose\": \"\",\n \"internalGesvision\": \"\",\n \"paymentKind\": \"V\",\n \"collectionKind\": \"RI\",\n \"cardTerminal\": \"MN\",\n \"webPosPaymentKind\": \"TC\",\n \"sriPaymentMethod\": \"T3\",\n \"olaCardType\": \"T24\",\n \"sapCrPaymentMethod\": \"SM\",\n \"satPaymentMethod\": \"VALUE_16\",\n \"requiresChange\": \"\",\n \"bankMovement\": \"\",\n \"automaticAccountingDate\": \"\",\n \"voucher\": \"\",\n \"voucherValidityDays\": \"\",\n \"promissoryNote\": \"\",\n \"alwaysRefundable\": \"\",\n \"cashKeeper\": \"\",\n \"postToLedger\": \"\",\n \"requiresValidation\": \"\",\n \"askInstalments\": \"\",\n \"subscription\": \"\",\n \"usableForIncoming\": \"\",\n \"usableForOutgoing\": \"\",\n \"taxPct\": \"\",\n \"companyId\": \"\",\n \"associatedAccounts\": [\n {\n \"companyId\": \"\",\n \"accountId\": \"\"\n },\n {\n \"companyId\": \"\",\n \"accountId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "edc0f2ee-197a-4036-9d5d-d150ccf5ab4b", "name": "Authenticated user is missing the `EDITAR_FORMASDEPAGO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "payment-methods", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment method ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"enabledForRefunds\": \"\",\n \"excludeFromCashClose\": \"\",\n \"internalGesvision\": \"\",\n \"paymentKind\": \"V\",\n \"collectionKind\": \"RI\",\n \"cardTerminal\": \"MN\",\n \"webPosPaymentKind\": \"TC\",\n \"sriPaymentMethod\": \"T3\",\n \"olaCardType\": \"T24\",\n \"sapCrPaymentMethod\": \"SM\",\n \"satPaymentMethod\": \"VALUE_16\",\n \"requiresChange\": \"\",\n \"bankMovement\": \"\",\n \"automaticAccountingDate\": \"\",\n \"voucher\": \"\",\n \"voucherValidityDays\": \"\",\n \"promissoryNote\": \"\",\n \"alwaysRefundable\": \"\",\n \"cashKeeper\": \"\",\n \"postToLedger\": \"\",\n \"requiresValidation\": \"\",\n \"askInstalments\": \"\",\n \"subscription\": \"\",\n \"usableForIncoming\": \"\",\n \"usableForOutgoing\": \"\",\n \"taxPct\": \"\",\n \"companyId\": \"\",\n \"associatedAccounts\": [\n {\n \"companyId\": \"\",\n \"accountId\": \"\"\n },\n {\n \"companyId\": \"\",\n \"accountId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bf880d62-79b1-429f-8fb9-9d6ed82d2574", "name": "Payment method not found", "originalRequest": { "url": { "path": [ "api", "v2", "payment-methods", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment method ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"enabledForRefunds\": \"\",\n \"excludeFromCashClose\": \"\",\n \"internalGesvision\": \"\",\n \"paymentKind\": \"V\",\n \"collectionKind\": \"RI\",\n \"cardTerminal\": \"MN\",\n \"webPosPaymentKind\": \"TC\",\n \"sriPaymentMethod\": \"T3\",\n \"olaCardType\": \"T24\",\n \"sapCrPaymentMethod\": \"SM\",\n \"satPaymentMethod\": \"VALUE_16\",\n \"requiresChange\": \"\",\n \"bankMovement\": \"\",\n \"automaticAccountingDate\": \"\",\n \"voucher\": \"\",\n \"voucherValidityDays\": \"\",\n \"promissoryNote\": \"\",\n \"alwaysRefundable\": \"\",\n \"cashKeeper\": \"\",\n \"postToLedger\": \"\",\n \"requiresValidation\": \"\",\n \"askInstalments\": \"\",\n \"subscription\": \"\",\n \"usableForIncoming\": \"\",\n \"usableForOutgoing\": \"\",\n \"taxPct\": \"\",\n \"companyId\": \"\",\n \"associatedAccounts\": [\n {\n \"companyId\": \"\",\n \"accountId\": \"\"\n },\n {\n \"companyId\": \"\",\n \"accountId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "80e0ee65-b4b2-4ca9-b42f-5d83b86a13bc", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "payment-methods", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment method ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"enabledForRefunds\": \"\",\n \"excludeFromCashClose\": \"\",\n \"internalGesvision\": \"\",\n \"paymentKind\": \"V\",\n \"collectionKind\": \"RI\",\n \"cardTerminal\": \"MN\",\n \"webPosPaymentKind\": \"TC\",\n \"sriPaymentMethod\": \"T3\",\n \"olaCardType\": \"T24\",\n \"sapCrPaymentMethod\": \"SM\",\n \"satPaymentMethod\": \"VALUE_16\",\n \"requiresChange\": \"\",\n \"bankMovement\": \"\",\n \"automaticAccountingDate\": \"\",\n \"voucher\": \"\",\n \"voucherValidityDays\": \"\",\n \"promissoryNote\": \"\",\n \"alwaysRefundable\": \"\",\n \"cashKeeper\": \"\",\n \"postToLedger\": \"\",\n \"requiresValidation\": \"\",\n \"askInstalments\": \"\",\n \"subscription\": \"\",\n \"usableForIncoming\": \"\",\n \"usableForOutgoing\": \"\",\n \"taxPct\": \"\",\n \"companyId\": \"\",\n \"associatedAccounts\": [\n {\n \"companyId\": \"\",\n \"accountId\": \"\"\n },\n {\n \"companyId\": \"\",\n \"accountId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3f0d47ae-70a9-456a-90d4-14d9352fa767", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "payment-methods", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment method ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"enabledForRefunds\": \"\",\n \"excludeFromCashClose\": \"\",\n \"internalGesvision\": \"\",\n \"paymentKind\": \"V\",\n \"collectionKind\": \"RI\",\n \"cardTerminal\": \"MN\",\n \"webPosPaymentKind\": \"TC\",\n \"sriPaymentMethod\": \"T3\",\n \"olaCardType\": \"T24\",\n \"sapCrPaymentMethod\": \"SM\",\n \"satPaymentMethod\": \"VALUE_16\",\n \"requiresChange\": \"\",\n \"bankMovement\": \"\",\n \"automaticAccountingDate\": \"\",\n \"voucher\": \"\",\n \"voucherValidityDays\": \"\",\n \"promissoryNote\": \"\",\n \"alwaysRefundable\": \"\",\n \"cashKeeper\": \"\",\n \"postToLedger\": \"\",\n \"requiresValidation\": \"\",\n \"askInstalments\": \"\",\n \"subscription\": \"\",\n \"usableForIncoming\": \"\",\n \"usableForOutgoing\": \"\",\n \"taxPct\": \"\",\n \"companyId\": \"\",\n \"associatedAccounts\": [\n {\n \"companyId\": \"\",\n \"accountId\": \"\"\n },\n {\n \"companyId\": \"\",\n \"accountId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d204d887-98bc-451e-8a4a-b8684141864a", "name": "Delete payment method", "request": { "name": "Delete payment method", "description": { "content": "Deletes a payment method. Send the `If-Match` header with the current ETag for optimistic concurrency control. Payment methods that are referenced by existing payments cannot be deleted (`409`).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "payment-methods", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Payment method ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "e0291767-a879-4ca7-b94e-74e91c735f98", "name": "Payment method deleted", "originalRequest": { "url": { "path": [ "api", "v2", "payment-methods", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment method ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e216adc7-dbe4-41fa-9514-d0e5f275b789", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "payment-methods", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment method ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "26531653-c256-40ff-96d3-0e8e3a9eb838", "name": "Authenticated user is missing the `BORRAR_FORMASDEPAGO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "payment-methods", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment method ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "89e6da9e-3d50-4704-80a8-3945e8d40819", "name": "Payment method not found", "originalRequest": { "url": { "path": [ "api", "v2", "payment-methods", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment method ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1af63fc4-f396-434e-ba78-ac8341a9bf9c", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "payment-methods", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment method ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "948989c4-a0f9-4299-b72f-3b100d386648", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "payment-methods", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment method ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "768cf7ba-389d-4249-8d6b-1e378535d3cd", "name": "Merge-patch payment method", "request": { "name": "Merge-patch payment method", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "payment-methods", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Payment method ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "61e333da-fecf-4137-823d-c9d764d8c7e9", "name": "Payment method patched", "originalRequest": { "url": { "path": [ "api", "v2", "payment-methods", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment method ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"enabledForRefunds\": \"\",\n \"excludeFromCashClose\": \"\",\n \"internalGesvision\": \"\",\n \"paymentKind\": \"I\",\n \"collectionKind\": \"CP\",\n \"cardTerminal\": \"MN\",\n \"webPosPaymentKind\": \"C\",\n \"sriPaymentMethod\": \"T20\",\n \"olaCardType\": \"T7\",\n \"sapCrPaymentMethod\": \"RT\",\n \"satPaymentMethod\": \"VALUE_8\",\n \"requiresChange\": \"\",\n \"bankMovement\": \"\",\n \"automaticAccountingDate\": \"\",\n \"voucher\": \"\",\n \"voucherValidityDays\": \"\",\n \"promissoryNote\": \"\",\n \"alwaysRefundable\": \"\",\n \"cashKeeper\": \"\",\n \"postToLedger\": \"\",\n \"requiresValidation\": \"\",\n \"askInstalments\": \"\",\n \"subscription\": \"\",\n \"usableForIncoming\": \"\",\n \"usableForOutgoing\": \"\",\n \"taxPct\": \"\",\n \"appliesPaymentTax\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"associatedAccounts\": [\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"accountId\": \"\",\n \"accountCode\": \"\",\n \"accountName\": \"\"\n },\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"accountId\": \"\",\n \"accountCode\": \"\",\n \"accountName\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8f7068d2-c87c-4527-a7ae-2891c787ea44", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "payment-methods", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment method ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e8e7876e-74fb-44fc-a7f0-7ad68de6de67", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "payment-methods", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment method ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6a41e073-c19a-4ae5-84f2-3766007c9f40", "name": "Authenticated user is missing the `EDITAR_FORMASDEPAGO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "payment-methods", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment method ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8606d45d-251b-4f76-afbf-1b02d4a1ed21", "name": "Payment method not found", "originalRequest": { "url": { "path": [ "api", "v2", "payment-methods", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment method ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bda88e14-6133-42d2-b22a-8f47d32bb608", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "payment-methods", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment method ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d5f99cd2-1fb8-4ca2-afcf-800a8c46e7c4", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "payment-methods", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment method ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "7ff7aef4-3395-410a-bff4-2bbf01b50336", "name": "List payment methods", "request": { "name": "List payment methods", "description": { "content": "Returns a paginated list of payment methods with envelope `{data, totalCount, skip, limit, hasMore}`. Supports optional RSQL `filter`, `sort` (default `lastModifiedAt:desc`), `skip`/`limit` pagination and `modifiedAfter`/`modifiedBefore` bookends.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "payment-methods" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "eec98ffd-e1ae-4556-ba74-70941e2dd64b", "name": "Page of payment methods", "originalRequest": { "url": { "path": [ "api", "v2", "payment-methods" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e54d55cf-e2f2-4625-bd4f-ef11c9d93f7b", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "payment-methods" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "86d61117-5731-4e4e-aca9-13f780d127b6", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "payment-methods" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2b833072-472c-4814-9858-5e51a7164935", "name": "Authenticated user is missing the `VER_FORMASDEPAGO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "payment-methods" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2402a930-6640-4ac3-9fb1-329dacaeff0a", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "payment-methods" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ba78e384-dcc1-4867-838b-50358bfdf913", "name": "Create payment method", "request": { "name": "Create payment method", "description": { "content": "Creates a new payment method. Behaviour flags that do not apply to the selected `paymentKind` are rejected with `400` (e.g. `requiresChange` outside cash kinds, `cardTerminal` outside card kinds, `taxPct` outside the foreign-currency kind). Business logic runs in the legacy WAR.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "payment-methods" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"enabledForRefunds\": \"\",\n \"excludeFromCashClose\": \"\",\n \"internalGesvision\": \"\",\n \"paymentKind\": \"V\",\n \"collectionKind\": \"RI\",\n \"cardTerminal\": \"MN\",\n \"webPosPaymentKind\": \"TC\",\n \"sriPaymentMethod\": \"T3\",\n \"olaCardType\": \"T24\",\n \"sapCrPaymentMethod\": \"SM\",\n \"satPaymentMethod\": \"VALUE_16\",\n \"requiresChange\": \"\",\n \"bankMovement\": \"\",\n \"automaticAccountingDate\": \"\",\n \"voucher\": \"\",\n \"voucherValidityDays\": \"\",\n \"promissoryNote\": \"\",\n \"alwaysRefundable\": \"\",\n \"cashKeeper\": \"\",\n \"postToLedger\": \"\",\n \"requiresValidation\": \"\",\n \"askInstalments\": \"\",\n \"subscription\": \"\",\n \"usableForIncoming\": \"\",\n \"usableForOutgoing\": \"\",\n \"taxPct\": \"\",\n \"companyId\": \"\",\n \"associatedAccounts\": [\n {\n \"companyId\": \"\",\n \"accountId\": \"\"\n },\n {\n \"companyId\": \"\",\n \"accountId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "f604925a-9438-45d7-87db-c3ed28d09117", "name": "Payment method created", "originalRequest": { "url": { "path": [ "api", "v2", "payment-methods" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"enabledForRefunds\": \"\",\n \"excludeFromCashClose\": \"\",\n \"internalGesvision\": \"\",\n \"paymentKind\": \"V\",\n \"collectionKind\": \"RI\",\n \"cardTerminal\": \"MN\",\n \"webPosPaymentKind\": \"TC\",\n \"sriPaymentMethod\": \"T3\",\n \"olaCardType\": \"T24\",\n \"sapCrPaymentMethod\": \"SM\",\n \"satPaymentMethod\": \"VALUE_16\",\n \"requiresChange\": \"\",\n \"bankMovement\": \"\",\n \"automaticAccountingDate\": \"\",\n \"voucher\": \"\",\n \"voucherValidityDays\": \"\",\n \"promissoryNote\": \"\",\n \"alwaysRefundable\": \"\",\n \"cashKeeper\": \"\",\n \"postToLedger\": \"\",\n \"requiresValidation\": \"\",\n \"askInstalments\": \"\",\n \"subscription\": \"\",\n \"usableForIncoming\": \"\",\n \"usableForOutgoing\": \"\",\n \"taxPct\": \"\",\n \"companyId\": \"\",\n \"associatedAccounts\": [\n {\n \"companyId\": \"\",\n \"accountId\": \"\"\n },\n {\n \"companyId\": \"\",\n \"accountId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"enabledForRefunds\": \"\",\n \"excludeFromCashClose\": \"\",\n \"internalGesvision\": \"\",\n \"paymentKind\": \"I\",\n \"collectionKind\": \"CP\",\n \"cardTerminal\": \"MN\",\n \"webPosPaymentKind\": \"C\",\n \"sriPaymentMethod\": \"T20\",\n \"olaCardType\": \"T7\",\n \"sapCrPaymentMethod\": \"RT\",\n \"satPaymentMethod\": \"VALUE_8\",\n \"requiresChange\": \"\",\n \"bankMovement\": \"\",\n \"automaticAccountingDate\": \"\",\n \"voucher\": \"\",\n \"voucherValidityDays\": \"\",\n \"promissoryNote\": \"\",\n \"alwaysRefundable\": \"\",\n \"cashKeeper\": \"\",\n \"postToLedger\": \"\",\n \"requiresValidation\": \"\",\n \"askInstalments\": \"\",\n \"subscription\": \"\",\n \"usableForIncoming\": \"\",\n \"usableForOutgoing\": \"\",\n \"taxPct\": \"\",\n \"appliesPaymentTax\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"associatedAccounts\": [\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"accountId\": \"\",\n \"accountCode\": \"\",\n \"accountName\": \"\"\n },\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"accountId\": \"\",\n \"accountCode\": \"\",\n \"accountName\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "edc50395-da74-418e-8499-fcb698383e38", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "payment-methods" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"enabledForRefunds\": \"\",\n \"excludeFromCashClose\": \"\",\n \"internalGesvision\": \"\",\n \"paymentKind\": \"V\",\n \"collectionKind\": \"RI\",\n \"cardTerminal\": \"MN\",\n \"webPosPaymentKind\": \"TC\",\n \"sriPaymentMethod\": \"T3\",\n \"olaCardType\": \"T24\",\n \"sapCrPaymentMethod\": \"SM\",\n \"satPaymentMethod\": \"VALUE_16\",\n \"requiresChange\": \"\",\n \"bankMovement\": \"\",\n \"automaticAccountingDate\": \"\",\n \"voucher\": \"\",\n \"voucherValidityDays\": \"\",\n \"promissoryNote\": \"\",\n \"alwaysRefundable\": \"\",\n \"cashKeeper\": \"\",\n \"postToLedger\": \"\",\n \"requiresValidation\": \"\",\n \"askInstalments\": \"\",\n \"subscription\": \"\",\n \"usableForIncoming\": \"\",\n \"usableForOutgoing\": \"\",\n \"taxPct\": \"\",\n \"companyId\": \"\",\n \"associatedAccounts\": [\n {\n \"companyId\": \"\",\n \"accountId\": \"\"\n },\n {\n \"companyId\": \"\",\n \"accountId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e4010d4f-5c86-43a6-bfd5-f8a833f58c6d", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "payment-methods" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"enabledForRefunds\": \"\",\n \"excludeFromCashClose\": \"\",\n \"internalGesvision\": \"\",\n \"paymentKind\": \"V\",\n \"collectionKind\": \"RI\",\n \"cardTerminal\": \"MN\",\n \"webPosPaymentKind\": \"TC\",\n \"sriPaymentMethod\": \"T3\",\n \"olaCardType\": \"T24\",\n \"sapCrPaymentMethod\": \"SM\",\n \"satPaymentMethod\": \"VALUE_16\",\n \"requiresChange\": \"\",\n \"bankMovement\": \"\",\n \"automaticAccountingDate\": \"\",\n \"voucher\": \"\",\n \"voucherValidityDays\": \"\",\n \"promissoryNote\": \"\",\n \"alwaysRefundable\": \"\",\n \"cashKeeper\": \"\",\n \"postToLedger\": \"\",\n \"requiresValidation\": \"\",\n \"askInstalments\": \"\",\n \"subscription\": \"\",\n \"usableForIncoming\": \"\",\n \"usableForOutgoing\": \"\",\n \"taxPct\": \"\",\n \"companyId\": \"\",\n \"associatedAccounts\": [\n {\n \"companyId\": \"\",\n \"accountId\": \"\"\n },\n {\n \"companyId\": \"\",\n \"accountId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ccbd3994-d24f-49c9-8a39-32cfe8319f80", "name": "Authenticated user is missing the `CREAR_FORMASDEPAGO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "payment-methods" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"enabledForRefunds\": \"\",\n \"excludeFromCashClose\": \"\",\n \"internalGesvision\": \"\",\n \"paymentKind\": \"V\",\n \"collectionKind\": \"RI\",\n \"cardTerminal\": \"MN\",\n \"webPosPaymentKind\": \"TC\",\n \"sriPaymentMethod\": \"T3\",\n \"olaCardType\": \"T24\",\n \"sapCrPaymentMethod\": \"SM\",\n \"satPaymentMethod\": \"VALUE_16\",\n \"requiresChange\": \"\",\n \"bankMovement\": \"\",\n \"automaticAccountingDate\": \"\",\n \"voucher\": \"\",\n \"voucherValidityDays\": \"\",\n \"promissoryNote\": \"\",\n \"alwaysRefundable\": \"\",\n \"cashKeeper\": \"\",\n \"postToLedger\": \"\",\n \"requiresValidation\": \"\",\n \"askInstalments\": \"\",\n \"subscription\": \"\",\n \"usableForIncoming\": \"\",\n \"usableForOutgoing\": \"\",\n \"taxPct\": \"\",\n \"companyId\": \"\",\n \"associatedAccounts\": [\n {\n \"companyId\": \"\",\n \"accountId\": \"\"\n },\n {\n \"companyId\": \"\",\n \"accountId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3a2701e6-bfa3-4655-8380-fe6947b0d913", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "payment-methods" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"enabledForRefunds\": \"\",\n \"excludeFromCashClose\": \"\",\n \"internalGesvision\": \"\",\n \"paymentKind\": \"V\",\n \"collectionKind\": \"RI\",\n \"cardTerminal\": \"MN\",\n \"webPosPaymentKind\": \"TC\",\n \"sriPaymentMethod\": \"T3\",\n \"olaCardType\": \"T24\",\n \"sapCrPaymentMethod\": \"SM\",\n \"satPaymentMethod\": \"VALUE_16\",\n \"requiresChange\": \"\",\n \"bankMovement\": \"\",\n \"automaticAccountingDate\": \"\",\n \"voucher\": \"\",\n \"voucherValidityDays\": \"\",\n \"promissoryNote\": \"\",\n \"alwaysRefundable\": \"\",\n \"cashKeeper\": \"\",\n \"postToLedger\": \"\",\n \"requiresValidation\": \"\",\n \"askInstalments\": \"\",\n \"subscription\": \"\",\n \"usableForIncoming\": \"\",\n \"usableForOutgoing\": \"\",\n \"taxPct\": \"\",\n \"companyId\": \"\",\n \"associatedAccounts\": [\n {\n \"companyId\": \"\",\n \"accountId\": \"\"\n },\n {\n \"companyId\": \"\",\n \"accountId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "new", "description": "", "item": [ { "id": "3cb1a718-faa6-4ec7-8062-fca39de5f193", "name": "Prototype payment method for a creation form", "request": { "name": "Prototype payment method for a creation form", "description": { "content": "Returns a non-persisted payment method pre-populated with backend defaults (current company, next free `code`, `enabled=true`, ledger posting enabled, usable for incoming documents). Optional JSON hints: `companyId`, `copyFromId`. Call `POST /api/v2/payment-methods` to persist.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "payment-methods", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "4d9c959b-67cd-49c2-903e-8f859303bcfe", "name": "Payment method prototype with defaults", "originalRequest": { "url": { "path": [ "api", "v2", "payment-methods", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"enabledForRefunds\": \"\",\n \"excludeFromCashClose\": \"\",\n \"internalGesvision\": \"\",\n \"paymentKind\": \"I\",\n \"collectionKind\": \"CP\",\n \"cardTerminal\": \"MN\",\n \"webPosPaymentKind\": \"C\",\n \"sriPaymentMethod\": \"T20\",\n \"olaCardType\": \"T7\",\n \"sapCrPaymentMethod\": \"RT\",\n \"satPaymentMethod\": \"VALUE_8\",\n \"requiresChange\": \"\",\n \"bankMovement\": \"\",\n \"automaticAccountingDate\": \"\",\n \"voucher\": \"\",\n \"voucherValidityDays\": \"\",\n \"promissoryNote\": \"\",\n \"alwaysRefundable\": \"\",\n \"cashKeeper\": \"\",\n \"postToLedger\": \"\",\n \"requiresValidation\": \"\",\n \"askInstalments\": \"\",\n \"subscription\": \"\",\n \"usableForIncoming\": \"\",\n \"usableForOutgoing\": \"\",\n \"taxPct\": \"\",\n \"appliesPaymentTax\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"associatedAccounts\": [\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"accountId\": \"\",\n \"accountCode\": \"\",\n \"accountName\": \"\"\n },\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"accountId\": \"\",\n \"accountCode\": \"\",\n \"accountName\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1bf895d4-cbc5-42ad-bc77-1dadb177e676", "name": "Invalid prepare-create hints", "originalRequest": { "url": { "path": [ "api", "v2", "payment-methods", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "36370e02-679a-4347-853d-b2da9cbddff2", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "payment-methods", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9f45d75f-bac8-4d96-a29f-55c773140e47", "name": "Authenticated user is missing the `CREAR_FORMASDEPAGO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "payment-methods", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "86381248-2bf6-4669-b35a-14b968f59da3", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "payment-methods", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "outgoing-payments", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "47f03510-ab1e-45ae-9b12-5d26222a91c2", "name": "Get outgoing payment by ID", "request": { "name": "Get outgoing payment by ID", "description": { "content": "Returns a single outgoing payment by its primary key. Returns 404 when the requested ID belongs to an incoming payment.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "outgoing-payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Outgoing payment ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "e031682f-cef8-4f71-bf51-0ae6c454a436", "name": "Outgoing payment found", "originalRequest": { "url": { "path": [ "api", "v2", "outgoing-payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Outgoing payment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"RI\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3a7ba879-c10c-44c4-ba0e-a38506ffad49", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "outgoing-payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Outgoing payment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "efc902b8-d79f-4b96-b382-b43909828bfa", "name": "Authenticated user is missing the `VER_PAGOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "outgoing-payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Outgoing payment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9a374f8e-9b9d-47d8-9ad4-ee6d475403b8", "name": "Outgoing payment not found", "originalRequest": { "url": { "path": [ "api", "v2", "outgoing-payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Outgoing payment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d49f7cbc-c402-4fba-9e5c-c860d34fe98f", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "outgoing-payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Outgoing payment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "99dbf8da-b7c4-4d36-b419-4abbfffd65a5", "name": "Update outgoing payment", "request": { "name": "Update outgoing payment", "description": { "content": "Full replacement of an existing outgoing payment. The `If-Match` header is accepted for API symmetry but is not enforced (Cobro has no OPTLOCK).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "outgoing-payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Outgoing payment ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check. (accepted for symmetry; Cobro has no OPTLOCK)", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "0f90171d-dda3-448c-9095-07f1d10e7146", "name": "Outgoing payment updated", "originalRequest": { "url": { "path": [ "api", "v2", "outgoing-payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Outgoing payment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check. (accepted for symmetry; Cobro has no OPTLOCK)", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"RI\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1d5af02e-f8ae-41d5-9bdb-a4ef1b859b95", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "outgoing-payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Outgoing payment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check. (accepted for symmetry; Cobro has no OPTLOCK)", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "146d340f-7cab-4aa3-9524-720fe52c7a7e", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "outgoing-payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Outgoing payment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check. (accepted for symmetry; Cobro has no OPTLOCK)", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3e6385a0-edf7-4d1a-92d8-7ea4fa647b15", "name": "Authenticated user is missing the `EDITAR_PAGOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "outgoing-payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Outgoing payment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check. (accepted for symmetry; Cobro has no OPTLOCK)", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e6a68872-1bbb-40b0-a8b7-fc232ac8ecdc", "name": "Outgoing payment not found", "originalRequest": { "url": { "path": [ "api", "v2", "outgoing-payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Outgoing payment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check. (accepted for symmetry; Cobro has no OPTLOCK)", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "445e758c-7594-4170-9493-c170ae696bcd", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "outgoing-payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Outgoing payment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check. (accepted for symmetry; Cobro has no OPTLOCK)", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b918830d-dfea-4ddd-83ba-b461da45f6a7", "name": "Delete outgoing payment", "request": { "name": "Delete outgoing payment", "description": { "content": "Deletes an outgoing payment. The `If-Match` header is accepted for API symmetry but not enforced (Cobro has no OPTLOCK).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "outgoing-payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Outgoing payment ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check. (accepted for symmetry; Cobro has no OPTLOCK)", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "0eaf15d5-b857-4688-9f71-1d3d6dfa38b3", "name": "Outgoing payment deleted", "originalRequest": { "url": { "path": [ "api", "v2", "outgoing-payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Outgoing payment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check. (accepted for symmetry; Cobro has no OPTLOCK)", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "62814967-2c52-45da-97e1-469b2448b769", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "outgoing-payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Outgoing payment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check. (accepted for symmetry; Cobro has no OPTLOCK)", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "21b4efae-2a4f-4c0c-9a27-ad92d212f3af", "name": "Authenticated user is missing the `BORRAR_PAGOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "outgoing-payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Outgoing payment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check. (accepted for symmetry; Cobro has no OPTLOCK)", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e5300c67-c680-414d-b51f-39d893a8cc58", "name": "Outgoing payment not found", "originalRequest": { "url": { "path": [ "api", "v2", "outgoing-payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Outgoing payment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check. (accepted for symmetry; Cobro has no OPTLOCK)", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6e144bb8-5f85-4f13-99c2-976f2e3031b2", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "outgoing-payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Outgoing payment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check. (accepted for symmetry; Cobro has no OPTLOCK)", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4c0df5a8-b640-4c81-b824-bf4a08bc4fd7", "name": "Merge-patch outgoing payment", "request": { "name": "Merge-patch outgoing payment", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "outgoing-payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Outgoing payment ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check. (accepted for symmetry; Cobro has no OPTLOCK)", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "8599ffd9-ac0c-47ec-a160-eaed8045e031", "name": "Outgoing payment patched", "originalRequest": { "url": { "path": [ "api", "v2", "outgoing-payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Outgoing payment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check. (accepted for symmetry; Cobro has no OPTLOCK)", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"RI\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fd39266b-8987-4dc6-a679-cdbc1477f01a", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details. Also returned for malformed merge-patch payloads.", "originalRequest": { "url": { "path": [ "api", "v2", "outgoing-payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Outgoing payment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check. (accepted for symmetry; Cobro has no OPTLOCK)", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "56f136d1-81df-4525-9485-7d10a856f8e6", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "outgoing-payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Outgoing payment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check. (accepted for symmetry; Cobro has no OPTLOCK)", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b9eddec3-ee4d-428f-a348-873fdefbe429", "name": "Authenticated user is missing the `EDITAR_PAGOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "outgoing-payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Outgoing payment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check. (accepted for symmetry; Cobro has no OPTLOCK)", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d223b2dc-7c19-49a8-8644-3ee830b50792", "name": "Outgoing payment not found", "originalRequest": { "url": { "path": [ "api", "v2", "outgoing-payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Outgoing payment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check. (accepted for symmetry; Cobro has no OPTLOCK)", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e753fc9e-3b27-4543-8260-9dac5b8780dc", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "outgoing-payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Outgoing payment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check. (accepted for symmetry; Cobro has no OPTLOCK)", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "c2ea46f6-1a2e-4b8d-9946-5a3b806c0170", "name": "List outgoing payments", "request": { "name": "List outgoing payments", "description": { "content": "Returns a paginated list of outgoing payments (pagos). The constraint `issued==false` is always enforced server-side.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "outgoing-payments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "e3093454-42b5-4b4b-afdb-0aa46f52b323", "name": "Page of outgoing payments", "originalRequest": { "url": { "path": [ "api", "v2", "outgoing-payments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "90fa0382-454e-4491-a15f-5f7ab1a91207", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "outgoing-payments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5770f02b-1c6b-4687-bb9e-53bdcab2a1a4", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "outgoing-payments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "eec90a6f-24cc-441d-aec3-c00406073158", "name": "Authenticated user is missing the `VER_PAGOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "outgoing-payments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3faaf0ca-652f-42bc-a755-df1030c20fbd", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "outgoing-payments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "405f0337-03d2-4d97-950e-c917bb2c8661", "name": "Create outgoing payment", "request": { "name": "Create outgoing payment", "description": { "content": "Records an outgoing payment against a purchase invoice, order or delivery note. The `issued` flag is forced to `false` server-side so the new Cobro is correctly classified as outgoing cash.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "outgoing-payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "9eba184a-ccea-4e7c-9e0d-2f5cdc4bad0b", "name": "Outgoing payment created", "originalRequest": { "url": { "path": [ "api", "v2", "outgoing-payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"RI\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "893a5d64-d2cf-42d2-b36c-692dbe66c8ee", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "outgoing-payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1c3ca66b-4f2b-416f-91d9-f59b2980237c", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "outgoing-payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "51207f60-8b8e-4909-b8ee-63f26675c021", "name": "Authenticated user is missing the `CREAR_PAGOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "outgoing-payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "47b71feb-f0c2-4bce-ab0c-01d6ddb03290", "name": "Referenced parent entity not found", "originalRequest": { "url": { "path": [ "api", "v2", "outgoing-payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "46eb1c3a-6a28-46c5-bda5-ef3e370c16b5", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "outgoing-payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "origin-types", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "dac7aaca-5ba7-481e-a83f-596139c18f11", "name": "Get origin type by ID", "request": { "name": "Get origin type by ID", "description": { "content": "Returns a single claim origin type by its primary key.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "origin-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Origin type ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "9edca3b1-e665-447e-b04a-d96dd8eb094f", "name": "Origin type found", "originalRequest": { "url": { "path": [ "api", "v2", "origin-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Origin type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "29aafdc7-1198-4e93-afd7-6d64176ed0bc", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "origin-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Origin type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9143b18d-a4b7-4c0d-9104-5fd108290379", "name": "Authenticated user is missing the `VER_RECLAMOTIPOORIGEN` permission", "originalRequest": { "url": { "path": [ "api", "v2", "origin-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Origin type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5155ed9f-76e4-44f4-8133-c22ad7010630", "name": "Origin type not found", "originalRequest": { "url": { "path": [ "api", "v2", "origin-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Origin type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "510cda5c-72f0-484b-9047-f3e847f54aba", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "origin-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Origin type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ead6085f-2ce8-4651-821f-eaf4b722cd48", "name": "Update origin type", "request": { "name": "Update origin type", "description": { "content": "Full replacement of an existing claim origin type. Send the `If-Match` header for optimistic concurrency (accepted but ignored ÔÇö not versioned).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "origin-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Origin type ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "e43c8eb5-db43-4138-99be-d0b8c421979d", "name": "Origin type updated", "originalRequest": { "url": { "path": [ "api", "v2", "origin-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Origin type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "791146fb-1f3a-460c-b7ad-1c5cd9c09b6a", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "origin-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Origin type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "33bbf850-f914-4873-bc09-373cf50358a3", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "origin-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Origin type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "094f179f-4fc7-40ad-8176-eef0f4ef5686", "name": "Authenticated user is missing the `EDITAR_RECLAMOTIPOORIGEN` permission", "originalRequest": { "url": { "path": [ "api", "v2", "origin-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Origin type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5df0651b-6116-4907-a908-95c01cda15d9", "name": "Origin type not found", "originalRequest": { "url": { "path": [ "api", "v2", "origin-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Origin type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e6618989-dea1-488e-b935-75e69cfdf867", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "origin-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Origin type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a419c2e6-b6d0-43ad-999d-e5d539668f0d", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "origin-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Origin type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "54bd4b99-f72c-4589-8a9e-3766feb9303f", "name": "Delete origin type", "request": { "name": "Delete origin type", "description": { "content": "Deletes a claim origin type. Send the `If-Match` header with the current ETag (accepted but ignored ÔÇö not versioned).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "origin-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Origin type ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "e523d2e4-ffec-4076-992e-c514b4dbdd91", "name": "Origin type deleted", "originalRequest": { "url": { "path": [ "api", "v2", "origin-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Origin type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6e56ec08-4a53-4849-800f-e7dea5758066", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "origin-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Origin type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "93a37540-bb34-42b1-bf98-e492c2c4a7bd", "name": "Authenticated user is missing the `BORRAR_RECLAMOTIPOORIGEN` permission", "originalRequest": { "url": { "path": [ "api", "v2", "origin-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Origin type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b645206c-1bad-46cd-b828-d83381801cdc", "name": "Origin type not found", "originalRequest": { "url": { "path": [ "api", "v2", "origin-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Origin type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f1d811f0-192b-4201-ace7-57a462820dc3", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "origin-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Origin type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6ae12f39-df64-4922-adfd-1516dfca7c4b", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "origin-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Origin type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e67a5ade-fc2f-471d-bf44-47e5e127a325", "name": "Merge-patch origin type", "request": { "name": "Merge-patch origin type", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "origin-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Origin type ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "79e04f26-a302-4661-ae7b-841ac63482d3", "name": "Origin type patched", "originalRequest": { "url": { "path": [ "api", "v2", "origin-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Origin type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "571bc664-8ece-4116-a571-a2f718ce7697", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details. Also returned for malformed merge-patch payloads.", "originalRequest": { "url": { "path": [ "api", "v2", "origin-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Origin type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d5f93281-6bb3-4ae3-bb08-f5ace28ba57a", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "origin-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Origin type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "49f3e4a0-c378-4e61-b099-2b0a94a7a91e", "name": "Authenticated user is missing the `EDITAR_RECLAMOTIPOORIGEN` permission", "originalRequest": { "url": { "path": [ "api", "v2", "origin-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Origin type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bdf7ad1d-fd86-4f9e-b2ee-679686607dd5", "name": "Origin type not found", "originalRequest": { "url": { "path": [ "api", "v2", "origin-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Origin type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "baa87c93-9d2c-4628-ba53-2f97f65cf72c", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "origin-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Origin type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1fe200bd-9f1b-4ef0-a486-462f8e5576d1", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "origin-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Origin type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "699abc5f-b42e-4699-bdb6-711e0c7ab772", "name": "List origin types", "request": { "name": "List origin types", "description": { "content": "Returns a paginated list of claim origin types with envelope `{data, totalCount, skip, limit, hasMore}`. Supports optional RSQL `filter`, `sort` (default `name:asc`), `skip`/`limit` pagination and `modifiedAfter`/`modifiedBefore` bookends.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "origin-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "8e040350-c171-46f7-a176-3aa09163be5e", "name": "Page of origin types", "originalRequest": { "url": { "path": [ "api", "v2", "origin-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "42ce7560-0a71-4f7f-af51-6cd9bfb0cc59", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "origin-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ce6030ed-1c3b-4459-a96b-fce3326aba83", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "origin-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "31735cc0-2f24-4530-9631-7b976c4dfb8b", "name": "Authenticated user is missing the `VER_RECLAMOTIPOORIGEN` permission", "originalRequest": { "url": { "path": [ "api", "v2", "origin-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "06c2e6a0-8c6c-4fe5-bf41-fa57893a0ba7", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "origin-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "50d83e7c-5dab-4f10-9163-3af4a43180db", "name": "Create origin type", "request": { "name": "Create origin type", "description": { "content": "Creates a new claim origin type. Business logic runs in the legacy WAR via the internal commands gateway.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "origin-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "c7ea5e6f-decf-4468-a296-baf7928fd6e3", "name": "Origin type created", "originalRequest": { "url": { "path": [ "api", "v2", "origin-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "39a2c9d3-48c3-4254-8205-07657b556953", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "origin-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "952d4f6a-a9a9-48ce-a0f1-91b26f633edb", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "origin-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9c07c34f-a4bd-43ea-845b-9c0976855ddc", "name": "Authenticated user is missing the `CREAR_RECLAMOTIPOORIGEN` permission", "originalRequest": { "url": { "path": [ "api", "v2", "origin-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "de7b390f-7291-450d-818c-56a5d16bb609", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "origin-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "new", "description": "", "item": [ { "id": "8a5bc8d3-94d1-4917-ac05-ca4727f4660c", "name": "Prototype origin type for a creation form", "request": { "name": "Prototype origin type for a creation form", "description": { "content": "Returns a non-persisted claim origin type pre-populated with backend defaults (`enabled=true`, current company). Optional JSON hints: `companyId`, `copyFromId`. The response has no `id`, `version` or audit fields; call `POST /api/v2/origin-types` afterwards to persist.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "origin-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "80c3b5f4-d81a-4b5b-ac9c-7d910f965871", "name": "Origin type prototype with defaults", "originalRequest": { "url": { "path": [ "api", "v2", "origin-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b5557573-106c-4230-89b2-a491d4dc9675", "name": "Invalid prepare-create hints", "originalRequest": { "url": { "path": [ "api", "v2", "origin-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cbe65e9e-f42f-4ede-8465-a04771546b4c", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "origin-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0ba76d95-f4be-4f29-a91b-abdfb7510c09", "name": "Authenticated user is missing the `CREAR_RECLAMOTIPOORIGEN` permission", "originalRequest": { "url": { "path": [ "api", "v2", "origin-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "723f6824-f55b-40b3-ab39-1565c6cae3bb", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "origin-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "optical-orders", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "5417e2f8-5bdb-40f7-9381-cf42d9b4a443", "name": "Get optical order by ID", "request": { "name": "Get optical order by ID", "description": { "content": "Returns a single optical order with the full nested shape (per-eye prescription, treatments, colorations, supplements).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "optical-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Optical order ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "25591672-5475-48ae-ab42-129a0b7c19fe", "name": "Optical order found", "originalRequest": { "url": { "path": [ "api", "v2", "optical-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Optical order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"documentType\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"documentStatusId\": \"\",\n \"documentStatusName\": \"\",\n \"assembled\": \"\",\n \"rawMaterialSelected\": \"\",\n \"bevelSent\": \"\",\n \"requestSupplier\": \"\",\n \"ownManufacturing\": \"\",\n \"ownFrame\": \"\",\n \"contactLenses\": \"\",\n \"sameLensBothEyes\": \"\",\n \"useRxForContactology\": \"\",\n \"documentDate\": \"\",\n \"firstPrintDate\": \"\",\n \"customerId\": \"\",\n \"customerName\": \"\",\n \"patientInitials\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"orderTypeId\": \"\",\n \"orderTypeName\": \"\",\n \"optometricExamId\": \"\",\n \"contactLensExamId\": \"\",\n \"customerOrderId\": \"\",\n \"invoiceId\": \"\",\n \"supplierOrderId\": \"\",\n \"productionOrderId\": \"\",\n \"frameShipmentTransferId\": \"\",\n \"bevelledLensTransferId\": \"\",\n \"finishedLensTransferId\": \"\",\n \"lastTraceId\": \"\",\n \"frameProductId\": \"\",\n \"frameProductName\": \"\",\n \"frameType\": \"AA\",\n \"frameHorizontal\": \"\",\n \"frameVertical\": \"\",\n \"frameBridge\": \"\",\n \"frameBiggestDiameter\": \"\",\n \"frameEffectiveDiameter\": \"\",\n \"frameMechanicalDistance\": \"\",\n \"pantoscopicAngle\": \"\",\n \"panoramicAngle\": \"\",\n \"vertexDistance\": \"\",\n \"nearWorkingDistance\": \"\",\n \"eyeRotationCenter\": \"\",\n \"pupillaryDistance\": \"\",\n \"medianDistance\": \"\",\n \"frameFit\": \"\",\n \"cCode\": \"\",\n \"heightRightEye\": \"\",\n \"heightLeftEye\": \"\",\n \"edgeThickness\": \"\",\n \"specialBase\": \"\",\n \"maxDecentrationRightEye\": \"\",\n \"maxDecentrationLeftEye\": \"\",\n \"dominantEye\": \"NONE\",\n \"nvb\": \"\",\n \"rightLensProductId\": \"\",\n \"rightLensProductName\": \"\",\n \"leftLensProductId\": \"\",\n \"leftLensProductName\": \"\",\n \"recommendedLensTypeRightEye\": \"OCCUPATIONAL\",\n \"recommendedLensTypeLeftEye\": \"BIFOCAL\",\n \"rawMaterialRightEyeProductId\": \"\",\n \"rawMaterialLeftEyeProductId\": \"\",\n \"rightEye\": {\n \"id\": \"\",\n \"eye\": \"RIGHT\",\n \"lensType\": \"PROGRESSIVE\",\n \"crystalType\": \"\",\n \"sphere\": \"\",\n \"cylinder\": \"\",\n \"axis\": \"\",\n \"addition\": \"\",\n \"near\": \"\",\n \"prism\": \"\",\n \"base\": \"\",\n \"diameter\": \"\",\n \"baseCurve\": \"\",\n \"height\": \"\",\n \"nearMonocularPd\": \"\",\n \"farMonocularPd\": \"\",\n \"lotNumber\": \"\",\n \"invima\": \"\"\n },\n \"leftEye\": {\n \"id\": \"\",\n \"eye\": \"RIGHT\",\n \"lensType\": \"INTERMEDIATE\",\n \"crystalType\": \"\",\n \"sphere\": \"\",\n \"cylinder\": \"\",\n \"axis\": \"\",\n \"addition\": \"\",\n \"near\": \"\",\n \"prism\": \"\",\n \"base\": \"\",\n \"diameter\": \"\",\n \"baseCurve\": \"\",\n \"height\": \"\",\n \"nearMonocularPd\": \"\",\n \"farMonocularPd\": \"\",\n \"lotNumber\": \"\",\n \"invima\": \"\"\n },\n \"rightEyeColoration\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"TREATMENT\",\n \"sourceLineId\": \"\"\n },\n \"leftEyeColoration\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"COLORATION\",\n \"sourceLineId\": \"\"\n },\n \"rightEyeTreatment\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"COLORATION\",\n \"sourceLineId\": \"\"\n },\n \"leftEyeTreatment\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"TREATMENT\",\n \"sourceLineId\": \"\"\n },\n \"rightEyeSupplements\": [\n {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"COLORATION\",\n \"sourceLineId\": \"\"\n },\n {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"TREATMENT\",\n \"sourceLineId\": \"\"\n }\n ],\n \"leftEyeSupplements\": [\n {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"SUPPLEMENT\",\n \"sourceLineId\": \"\"\n },\n {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"TREATMENT\",\n \"sourceLineId\": \"\"\n }\n ],\n \"internalRef\": \"\",\n \"supplier\": \"\",\n \"notes\": \"\",\n \"notificationsSent\": \"\",\n \"notifyPatient\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\",\n \"sourceSystem\": \"\",\n \"ccode\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7c11415b-ba01-4f9d-826b-22a0385c68e1", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "optical-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Optical order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6cc3d77d-d8cf-4978-954c-71dd934a8901", "name": "Authenticated user is missing the `VER_ENCARGO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "optical-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Optical order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "dae8dbd5-1d12-4277-91f7-d94fc7fdc607", "name": "Optical order not found", "originalRequest": { "url": { "path": [ "api", "v2", "optical-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Optical order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ca5926c3-6f66-44c4-b322-ea7f0d9baddc", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "optical-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Optical order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6523f33f-a76b-432a-a11c-6d70834a18f8", "name": "Update optical order", "request": { "name": "Update optical order", "description": { "content": "Full replacement of an existing optical order. Send the `If-Match` header with the current ETag for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "optical-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Optical order ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"assembled\": \"\",\n \"rawMaterialSelected\": \"\",\n \"bevelSent\": \"\",\n \"requestSupplier\": \"\",\n \"ownManufacturing\": \"\",\n \"ownFrame\": \"\",\n \"contactLenses\": \"\",\n \"sameLensBothEyes\": \"\",\n \"useRxForContactology\": \"\",\n \"documentDate\": \"\",\n \"customerId\": \"\",\n \"patientInitials\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"orderTypeId\": \"\",\n \"optometricExamId\": \"\",\n \"contactLensExamId\": \"\",\n \"customerOrderId\": \"\",\n \"invoiceId\": \"\",\n \"supplierOrderId\": \"\",\n \"productionOrderId\": \"\",\n \"frameProductId\": \"\",\n \"frameType\": \"AA\",\n \"frameHorizontal\": \"\",\n \"frameVertical\": \"\",\n \"frameBridge\": \"\",\n \"frameBiggestDiameter\": \"\",\n \"frameEffectiveDiameter\": \"\",\n \"frameMechanicalDistance\": \"\",\n \"pantoscopicAngle\": \"\",\n \"panoramicAngle\": \"\",\n \"vertexDistance\": \"\",\n \"nearWorkingDistance\": \"\",\n \"eyeRotationCenter\": \"\",\n \"pupillaryDistance\": \"\",\n \"medianDistance\": \"\",\n \"frameFit\": \"\",\n \"cCode\": \"\",\n \"heightRightEye\": \"\",\n \"heightLeftEye\": \"\",\n \"edgeThickness\": \"\",\n \"specialBase\": \"\",\n \"maxDecentrationRightEye\": \"\",\n \"maxDecentrationLeftEye\": \"\",\n \"dominantEye\": \"NONE\",\n \"nvb\": \"\",\n \"rightLensProductId\": \"\",\n \"leftLensProductId\": \"\",\n \"recommendedLensTypeRightEye\": \"OCCUPATIONAL\",\n \"recommendedLensTypeLeftEye\": \"FAR\",\n \"rawMaterialRightEyeProductId\": \"\",\n \"rawMaterialLeftEyeProductId\": \"\",\n \"rightEye\": {\n \"id\": \"\",\n \"eye\": \"RIGHT\",\n \"lensType\": \"MULTIFOCAL\",\n \"crystalType\": \"\",\n \"sphere\": \"\",\n \"cylinder\": \"\",\n \"axis\": \"\",\n \"addition\": \"\",\n \"near\": \"\",\n \"prism\": \"\",\n \"base\": \"\",\n \"diameter\": \"\",\n \"baseCurve\": \"\",\n \"height\": \"\",\n \"nearMonocularPd\": \"\",\n \"farMonocularPd\": \"\",\n \"lotNumber\": \"\",\n \"invima\": \"\"\n },\n \"leftEye\": {\n \"id\": \"\",\n \"eye\": \"RIGHT\",\n \"lensType\": \"OCCUPATIONAL\",\n \"crystalType\": \"\",\n \"sphere\": \"\",\n \"cylinder\": \"\",\n \"axis\": \"\",\n \"addition\": \"\",\n \"near\": \"\",\n \"prism\": \"\",\n \"base\": \"\",\n \"diameter\": \"\",\n \"baseCurve\": \"\",\n \"height\": \"\",\n \"nearMonocularPd\": \"\",\n \"farMonocularPd\": \"\",\n \"lotNumber\": \"\",\n \"invima\": \"\"\n },\n \"rightEyeColorationProductId\": \"\",\n \"leftEyeColorationProductId\": \"\",\n \"rightEyeTreatmentProductId\": \"\",\n \"leftEyeTreatmentProductId\": \"\",\n \"rightEyeSupplementProductIds\": [\n \"\",\n \"\"\n ],\n \"leftEyeSupplementProductIds\": [\n \"\",\n \"\"\n ],\n \"rightEyeColoration\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"SUPPLEMENT\",\n \"sourceLineId\": \"\"\n },\n \"leftEyeColoration\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"SUPPLEMENT\",\n \"sourceLineId\": \"\"\n },\n \"rightEyeTreatment\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"TREATMENT\",\n \"sourceLineId\": \"\"\n },\n \"leftEyeTreatment\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"SUPPLEMENT\",\n \"sourceLineId\": \"\"\n },\n \"internalRef\": \"\",\n \"supplier\": \"\",\n \"notes\": \"\",\n \"notifyPatient\": \"\",\n \"ccode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "e8420710-18b5-4794-872c-9e50ed22de67", "name": "Optical order updated", "originalRequest": { "url": { "path": [ "api", "v2", "optical-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Optical order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"assembled\": \"\",\n \"rawMaterialSelected\": \"\",\n \"bevelSent\": \"\",\n \"requestSupplier\": \"\",\n \"ownManufacturing\": \"\",\n \"ownFrame\": \"\",\n \"contactLenses\": \"\",\n \"sameLensBothEyes\": \"\",\n \"useRxForContactology\": \"\",\n \"documentDate\": \"\",\n \"customerId\": \"\",\n \"patientInitials\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"orderTypeId\": \"\",\n \"optometricExamId\": \"\",\n \"contactLensExamId\": \"\",\n \"customerOrderId\": \"\",\n \"invoiceId\": \"\",\n \"supplierOrderId\": \"\",\n \"productionOrderId\": \"\",\n \"frameProductId\": \"\",\n \"frameType\": \"AA\",\n \"frameHorizontal\": \"\",\n \"frameVertical\": \"\",\n \"frameBridge\": \"\",\n \"frameBiggestDiameter\": \"\",\n \"frameEffectiveDiameter\": \"\",\n \"frameMechanicalDistance\": \"\",\n \"pantoscopicAngle\": \"\",\n \"panoramicAngle\": \"\",\n \"vertexDistance\": \"\",\n \"nearWorkingDistance\": \"\",\n \"eyeRotationCenter\": \"\",\n \"pupillaryDistance\": \"\",\n \"medianDistance\": \"\",\n \"frameFit\": \"\",\n \"cCode\": \"\",\n \"heightRightEye\": \"\",\n \"heightLeftEye\": \"\",\n \"edgeThickness\": \"\",\n \"specialBase\": \"\",\n \"maxDecentrationRightEye\": \"\",\n \"maxDecentrationLeftEye\": \"\",\n \"dominantEye\": \"NONE\",\n \"nvb\": \"\",\n \"rightLensProductId\": \"\",\n \"leftLensProductId\": \"\",\n \"recommendedLensTypeRightEye\": \"OCCUPATIONAL\",\n \"recommendedLensTypeLeftEye\": \"FAR\",\n \"rawMaterialRightEyeProductId\": \"\",\n \"rawMaterialLeftEyeProductId\": \"\",\n \"rightEye\": {\n \"id\": \"\",\n \"eye\": \"RIGHT\",\n \"lensType\": \"MULTIFOCAL\",\n \"crystalType\": \"\",\n \"sphere\": \"\",\n \"cylinder\": \"\",\n \"axis\": \"\",\n \"addition\": \"\",\n \"near\": \"\",\n \"prism\": \"\",\n \"base\": \"\",\n \"diameter\": \"\",\n \"baseCurve\": \"\",\n \"height\": \"\",\n \"nearMonocularPd\": \"\",\n \"farMonocularPd\": \"\",\n \"lotNumber\": \"\",\n \"invima\": \"\"\n },\n \"leftEye\": {\n \"id\": \"\",\n \"eye\": \"RIGHT\",\n \"lensType\": \"OCCUPATIONAL\",\n \"crystalType\": \"\",\n \"sphere\": \"\",\n \"cylinder\": \"\",\n \"axis\": \"\",\n \"addition\": \"\",\n \"near\": \"\",\n \"prism\": \"\",\n \"base\": \"\",\n \"diameter\": \"\",\n \"baseCurve\": \"\",\n \"height\": \"\",\n \"nearMonocularPd\": \"\",\n \"farMonocularPd\": \"\",\n \"lotNumber\": \"\",\n \"invima\": \"\"\n },\n \"rightEyeColorationProductId\": \"\",\n \"leftEyeColorationProductId\": \"\",\n \"rightEyeTreatmentProductId\": \"\",\n \"leftEyeTreatmentProductId\": \"\",\n \"rightEyeSupplementProductIds\": [\n \"\",\n \"\"\n ],\n \"leftEyeSupplementProductIds\": [\n \"\",\n \"\"\n ],\n \"rightEyeColoration\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"SUPPLEMENT\",\n \"sourceLineId\": \"\"\n },\n \"leftEyeColoration\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"SUPPLEMENT\",\n \"sourceLineId\": \"\"\n },\n \"rightEyeTreatment\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"TREATMENT\",\n \"sourceLineId\": \"\"\n },\n \"leftEyeTreatment\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"SUPPLEMENT\",\n \"sourceLineId\": \"\"\n },\n \"internalRef\": \"\",\n \"supplier\": \"\",\n \"notes\": \"\",\n \"notifyPatient\": \"\",\n \"ccode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"documentType\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"documentStatusId\": \"\",\n \"documentStatusName\": \"\",\n \"assembled\": \"\",\n \"rawMaterialSelected\": \"\",\n \"bevelSent\": \"\",\n \"requestSupplier\": \"\",\n \"ownManufacturing\": \"\",\n \"ownFrame\": \"\",\n \"contactLenses\": \"\",\n \"sameLensBothEyes\": \"\",\n \"useRxForContactology\": \"\",\n \"documentDate\": \"\",\n \"firstPrintDate\": \"\",\n \"customerId\": \"\",\n \"customerName\": \"\",\n \"patientInitials\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"orderTypeId\": \"\",\n \"orderTypeName\": \"\",\n \"optometricExamId\": \"\",\n \"contactLensExamId\": \"\",\n \"customerOrderId\": \"\",\n \"invoiceId\": \"\",\n \"supplierOrderId\": \"\",\n \"productionOrderId\": \"\",\n \"frameShipmentTransferId\": \"\",\n \"bevelledLensTransferId\": \"\",\n \"finishedLensTransferId\": \"\",\n \"lastTraceId\": \"\",\n \"frameProductId\": \"\",\n \"frameProductName\": \"\",\n \"frameType\": \"AA\",\n \"frameHorizontal\": \"\",\n \"frameVertical\": \"\",\n \"frameBridge\": \"\",\n \"frameBiggestDiameter\": \"\",\n \"frameEffectiveDiameter\": \"\",\n \"frameMechanicalDistance\": \"\",\n \"pantoscopicAngle\": \"\",\n \"panoramicAngle\": \"\",\n \"vertexDistance\": \"\",\n \"nearWorkingDistance\": \"\",\n \"eyeRotationCenter\": \"\",\n \"pupillaryDistance\": \"\",\n \"medianDistance\": \"\",\n \"frameFit\": \"\",\n \"cCode\": \"\",\n \"heightRightEye\": \"\",\n \"heightLeftEye\": \"\",\n \"edgeThickness\": \"\",\n \"specialBase\": \"\",\n \"maxDecentrationRightEye\": \"\",\n \"maxDecentrationLeftEye\": \"\",\n \"dominantEye\": \"NONE\",\n \"nvb\": \"\",\n \"rightLensProductId\": \"\",\n \"rightLensProductName\": \"\",\n \"leftLensProductId\": \"\",\n \"leftLensProductName\": \"\",\n \"recommendedLensTypeRightEye\": \"OCCUPATIONAL\",\n \"recommendedLensTypeLeftEye\": \"BIFOCAL\",\n \"rawMaterialRightEyeProductId\": \"\",\n \"rawMaterialLeftEyeProductId\": \"\",\n \"rightEye\": {\n \"id\": \"\",\n \"eye\": \"RIGHT\",\n \"lensType\": \"PROGRESSIVE\",\n \"crystalType\": \"\",\n \"sphere\": \"\",\n \"cylinder\": \"\",\n \"axis\": \"\",\n \"addition\": \"\",\n \"near\": \"\",\n \"prism\": \"\",\n \"base\": \"\",\n \"diameter\": \"\",\n \"baseCurve\": \"\",\n \"height\": \"\",\n \"nearMonocularPd\": \"\",\n \"farMonocularPd\": \"\",\n \"lotNumber\": \"\",\n \"invima\": \"\"\n },\n \"leftEye\": {\n \"id\": \"\",\n \"eye\": \"RIGHT\",\n \"lensType\": \"INTERMEDIATE\",\n \"crystalType\": \"\",\n \"sphere\": \"\",\n \"cylinder\": \"\",\n \"axis\": \"\",\n \"addition\": \"\",\n \"near\": \"\",\n \"prism\": \"\",\n \"base\": \"\",\n \"diameter\": \"\",\n \"baseCurve\": \"\",\n \"height\": \"\",\n \"nearMonocularPd\": \"\",\n \"farMonocularPd\": \"\",\n \"lotNumber\": \"\",\n \"invima\": \"\"\n },\n \"rightEyeColoration\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"TREATMENT\",\n \"sourceLineId\": \"\"\n },\n \"leftEyeColoration\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"COLORATION\",\n \"sourceLineId\": \"\"\n },\n \"rightEyeTreatment\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"COLORATION\",\n \"sourceLineId\": \"\"\n },\n \"leftEyeTreatment\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"TREATMENT\",\n \"sourceLineId\": \"\"\n },\n \"rightEyeSupplements\": [\n {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"COLORATION\",\n \"sourceLineId\": \"\"\n },\n {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"TREATMENT\",\n \"sourceLineId\": \"\"\n }\n ],\n \"leftEyeSupplements\": [\n {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"SUPPLEMENT\",\n \"sourceLineId\": \"\"\n },\n {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"TREATMENT\",\n \"sourceLineId\": \"\"\n }\n ],\n \"internalRef\": \"\",\n \"supplier\": \"\",\n \"notes\": \"\",\n \"notificationsSent\": \"\",\n \"notifyPatient\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\",\n \"sourceSystem\": \"\",\n \"ccode\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5939b731-f2ea-4cd6-a7d0-bb84a639a023", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "optical-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Optical order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"assembled\": \"\",\n \"rawMaterialSelected\": \"\",\n \"bevelSent\": \"\",\n \"requestSupplier\": \"\",\n \"ownManufacturing\": \"\",\n \"ownFrame\": \"\",\n \"contactLenses\": \"\",\n \"sameLensBothEyes\": \"\",\n \"useRxForContactology\": \"\",\n \"documentDate\": \"\",\n \"customerId\": \"\",\n \"patientInitials\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"orderTypeId\": \"\",\n \"optometricExamId\": \"\",\n \"contactLensExamId\": \"\",\n \"customerOrderId\": \"\",\n \"invoiceId\": \"\",\n \"supplierOrderId\": \"\",\n \"productionOrderId\": \"\",\n \"frameProductId\": \"\",\n \"frameType\": \"AA\",\n \"frameHorizontal\": \"\",\n \"frameVertical\": \"\",\n \"frameBridge\": \"\",\n \"frameBiggestDiameter\": \"\",\n \"frameEffectiveDiameter\": \"\",\n \"frameMechanicalDistance\": \"\",\n \"pantoscopicAngle\": \"\",\n \"panoramicAngle\": \"\",\n \"vertexDistance\": \"\",\n \"nearWorkingDistance\": \"\",\n \"eyeRotationCenter\": \"\",\n \"pupillaryDistance\": \"\",\n \"medianDistance\": \"\",\n \"frameFit\": \"\",\n \"cCode\": \"\",\n \"heightRightEye\": \"\",\n \"heightLeftEye\": \"\",\n \"edgeThickness\": \"\",\n \"specialBase\": \"\",\n \"maxDecentrationRightEye\": \"\",\n \"maxDecentrationLeftEye\": \"\",\n \"dominantEye\": \"NONE\",\n \"nvb\": \"\",\n \"rightLensProductId\": \"\",\n \"leftLensProductId\": \"\",\n \"recommendedLensTypeRightEye\": \"OCCUPATIONAL\",\n \"recommendedLensTypeLeftEye\": \"FAR\",\n \"rawMaterialRightEyeProductId\": \"\",\n \"rawMaterialLeftEyeProductId\": \"\",\n \"rightEye\": {\n \"id\": \"\",\n \"eye\": \"RIGHT\",\n \"lensType\": \"MULTIFOCAL\",\n \"crystalType\": \"\",\n \"sphere\": \"\",\n \"cylinder\": \"\",\n \"axis\": \"\",\n \"addition\": \"\",\n \"near\": \"\",\n \"prism\": \"\",\n \"base\": \"\",\n \"diameter\": \"\",\n \"baseCurve\": \"\",\n \"height\": \"\",\n \"nearMonocularPd\": \"\",\n \"farMonocularPd\": \"\",\n \"lotNumber\": \"\",\n \"invima\": \"\"\n },\n \"leftEye\": {\n \"id\": \"\",\n \"eye\": \"RIGHT\",\n \"lensType\": \"OCCUPATIONAL\",\n \"crystalType\": \"\",\n \"sphere\": \"\",\n \"cylinder\": \"\",\n \"axis\": \"\",\n \"addition\": \"\",\n \"near\": \"\",\n \"prism\": \"\",\n \"base\": \"\",\n \"diameter\": \"\",\n \"baseCurve\": \"\",\n \"height\": \"\",\n \"nearMonocularPd\": \"\",\n \"farMonocularPd\": \"\",\n \"lotNumber\": \"\",\n \"invima\": \"\"\n },\n \"rightEyeColorationProductId\": \"\",\n \"leftEyeColorationProductId\": \"\",\n \"rightEyeTreatmentProductId\": \"\",\n \"leftEyeTreatmentProductId\": \"\",\n \"rightEyeSupplementProductIds\": [\n \"\",\n \"\"\n ],\n \"leftEyeSupplementProductIds\": [\n \"\",\n \"\"\n ],\n \"rightEyeColoration\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"SUPPLEMENT\",\n \"sourceLineId\": \"\"\n },\n \"leftEyeColoration\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"SUPPLEMENT\",\n \"sourceLineId\": \"\"\n },\n \"rightEyeTreatment\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"TREATMENT\",\n \"sourceLineId\": \"\"\n },\n \"leftEyeTreatment\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"SUPPLEMENT\",\n \"sourceLineId\": \"\"\n },\n \"internalRef\": \"\",\n \"supplier\": \"\",\n \"notes\": \"\",\n \"notifyPatient\": \"\",\n \"ccode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0aaed37f-cd87-46ae-aae9-8e0b5afbcc6d", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "optical-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Optical order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"assembled\": \"\",\n \"rawMaterialSelected\": \"\",\n \"bevelSent\": \"\",\n \"requestSupplier\": \"\",\n \"ownManufacturing\": \"\",\n \"ownFrame\": \"\",\n \"contactLenses\": \"\",\n \"sameLensBothEyes\": \"\",\n \"useRxForContactology\": \"\",\n \"documentDate\": \"\",\n \"customerId\": \"\",\n \"patientInitials\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"orderTypeId\": \"\",\n \"optometricExamId\": \"\",\n \"contactLensExamId\": \"\",\n \"customerOrderId\": \"\",\n \"invoiceId\": \"\",\n \"supplierOrderId\": \"\",\n \"productionOrderId\": \"\",\n \"frameProductId\": \"\",\n \"frameType\": \"AA\",\n \"frameHorizontal\": \"\",\n \"frameVertical\": \"\",\n \"frameBridge\": \"\",\n \"frameBiggestDiameter\": \"\",\n \"frameEffectiveDiameter\": \"\",\n \"frameMechanicalDistance\": \"\",\n \"pantoscopicAngle\": \"\",\n \"panoramicAngle\": \"\",\n \"vertexDistance\": \"\",\n \"nearWorkingDistance\": \"\",\n \"eyeRotationCenter\": \"\",\n \"pupillaryDistance\": \"\",\n \"medianDistance\": \"\",\n \"frameFit\": \"\",\n \"cCode\": \"\",\n \"heightRightEye\": \"\",\n \"heightLeftEye\": \"\",\n \"edgeThickness\": \"\",\n \"specialBase\": \"\",\n \"maxDecentrationRightEye\": \"\",\n \"maxDecentrationLeftEye\": \"\",\n \"dominantEye\": \"NONE\",\n \"nvb\": \"\",\n \"rightLensProductId\": \"\",\n \"leftLensProductId\": \"\",\n \"recommendedLensTypeRightEye\": \"OCCUPATIONAL\",\n \"recommendedLensTypeLeftEye\": \"FAR\",\n \"rawMaterialRightEyeProductId\": \"\",\n \"rawMaterialLeftEyeProductId\": \"\",\n \"rightEye\": {\n \"id\": \"\",\n \"eye\": \"RIGHT\",\n \"lensType\": \"MULTIFOCAL\",\n \"crystalType\": \"\",\n \"sphere\": \"\",\n \"cylinder\": \"\",\n \"axis\": \"\",\n \"addition\": \"\",\n \"near\": \"\",\n \"prism\": \"\",\n \"base\": \"\",\n \"diameter\": \"\",\n \"baseCurve\": \"\",\n \"height\": \"\",\n \"nearMonocularPd\": \"\",\n \"farMonocularPd\": \"\",\n \"lotNumber\": \"\",\n \"invima\": \"\"\n },\n \"leftEye\": {\n \"id\": \"\",\n \"eye\": \"RIGHT\",\n \"lensType\": \"OCCUPATIONAL\",\n \"crystalType\": \"\",\n \"sphere\": \"\",\n \"cylinder\": \"\",\n \"axis\": \"\",\n \"addition\": \"\",\n \"near\": \"\",\n \"prism\": \"\",\n \"base\": \"\",\n \"diameter\": \"\",\n \"baseCurve\": \"\",\n \"height\": \"\",\n \"nearMonocularPd\": \"\",\n \"farMonocularPd\": \"\",\n \"lotNumber\": \"\",\n \"invima\": \"\"\n },\n \"rightEyeColorationProductId\": \"\",\n \"leftEyeColorationProductId\": \"\",\n \"rightEyeTreatmentProductId\": \"\",\n \"leftEyeTreatmentProductId\": \"\",\n \"rightEyeSupplementProductIds\": [\n \"\",\n \"\"\n ],\n \"leftEyeSupplementProductIds\": [\n \"\",\n \"\"\n ],\n \"rightEyeColoration\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"SUPPLEMENT\",\n \"sourceLineId\": \"\"\n },\n \"leftEyeColoration\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"SUPPLEMENT\",\n \"sourceLineId\": \"\"\n },\n \"rightEyeTreatment\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"TREATMENT\",\n \"sourceLineId\": \"\"\n },\n \"leftEyeTreatment\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"SUPPLEMENT\",\n \"sourceLineId\": \"\"\n },\n \"internalRef\": \"\",\n \"supplier\": \"\",\n \"notes\": \"\",\n \"notifyPatient\": \"\",\n \"ccode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7e7ee3aa-9596-4a87-8ca3-60c8ea2485a2", "name": "Authenticated user is missing the `EDITAR_ENCARGO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "optical-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Optical order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"assembled\": \"\",\n \"rawMaterialSelected\": \"\",\n \"bevelSent\": \"\",\n \"requestSupplier\": \"\",\n \"ownManufacturing\": \"\",\n \"ownFrame\": \"\",\n \"contactLenses\": \"\",\n \"sameLensBothEyes\": \"\",\n \"useRxForContactology\": \"\",\n \"documentDate\": \"\",\n \"customerId\": \"\",\n \"patientInitials\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"orderTypeId\": \"\",\n \"optometricExamId\": \"\",\n \"contactLensExamId\": \"\",\n \"customerOrderId\": \"\",\n \"invoiceId\": \"\",\n \"supplierOrderId\": \"\",\n \"productionOrderId\": \"\",\n \"frameProductId\": \"\",\n \"frameType\": \"AA\",\n \"frameHorizontal\": \"\",\n \"frameVertical\": \"\",\n \"frameBridge\": \"\",\n \"frameBiggestDiameter\": \"\",\n \"frameEffectiveDiameter\": \"\",\n \"frameMechanicalDistance\": \"\",\n \"pantoscopicAngle\": \"\",\n \"panoramicAngle\": \"\",\n \"vertexDistance\": \"\",\n \"nearWorkingDistance\": \"\",\n \"eyeRotationCenter\": \"\",\n \"pupillaryDistance\": \"\",\n \"medianDistance\": \"\",\n \"frameFit\": \"\",\n \"cCode\": \"\",\n \"heightRightEye\": \"\",\n \"heightLeftEye\": \"\",\n \"edgeThickness\": \"\",\n \"specialBase\": \"\",\n \"maxDecentrationRightEye\": \"\",\n \"maxDecentrationLeftEye\": \"\",\n \"dominantEye\": \"NONE\",\n \"nvb\": \"\",\n \"rightLensProductId\": \"\",\n \"leftLensProductId\": \"\",\n \"recommendedLensTypeRightEye\": \"OCCUPATIONAL\",\n \"recommendedLensTypeLeftEye\": \"FAR\",\n \"rawMaterialRightEyeProductId\": \"\",\n \"rawMaterialLeftEyeProductId\": \"\",\n \"rightEye\": {\n \"id\": \"\",\n \"eye\": \"RIGHT\",\n \"lensType\": \"MULTIFOCAL\",\n \"crystalType\": \"\",\n \"sphere\": \"\",\n \"cylinder\": \"\",\n \"axis\": \"\",\n \"addition\": \"\",\n \"near\": \"\",\n \"prism\": \"\",\n \"base\": \"\",\n \"diameter\": \"\",\n \"baseCurve\": \"\",\n \"height\": \"\",\n \"nearMonocularPd\": \"\",\n \"farMonocularPd\": \"\",\n \"lotNumber\": \"\",\n \"invima\": \"\"\n },\n \"leftEye\": {\n \"id\": \"\",\n \"eye\": \"RIGHT\",\n \"lensType\": \"OCCUPATIONAL\",\n \"crystalType\": \"\",\n \"sphere\": \"\",\n \"cylinder\": \"\",\n \"axis\": \"\",\n \"addition\": \"\",\n \"near\": \"\",\n \"prism\": \"\",\n \"base\": \"\",\n \"diameter\": \"\",\n \"baseCurve\": \"\",\n \"height\": \"\",\n \"nearMonocularPd\": \"\",\n \"farMonocularPd\": \"\",\n \"lotNumber\": \"\",\n \"invima\": \"\"\n },\n \"rightEyeColorationProductId\": \"\",\n \"leftEyeColorationProductId\": \"\",\n \"rightEyeTreatmentProductId\": \"\",\n \"leftEyeTreatmentProductId\": \"\",\n \"rightEyeSupplementProductIds\": [\n \"\",\n \"\"\n ],\n \"leftEyeSupplementProductIds\": [\n \"\",\n \"\"\n ],\n \"rightEyeColoration\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"SUPPLEMENT\",\n \"sourceLineId\": \"\"\n },\n \"leftEyeColoration\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"SUPPLEMENT\",\n \"sourceLineId\": \"\"\n },\n \"rightEyeTreatment\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"TREATMENT\",\n \"sourceLineId\": \"\"\n },\n \"leftEyeTreatment\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"SUPPLEMENT\",\n \"sourceLineId\": \"\"\n },\n \"internalRef\": \"\",\n \"supplier\": \"\",\n \"notes\": \"\",\n \"notifyPatient\": \"\",\n \"ccode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d0efbea0-2bdc-482f-9ba1-b94322d157b9", "name": "Optical order not found", "originalRequest": { "url": { "path": [ "api", "v2", "optical-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Optical order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"assembled\": \"\",\n \"rawMaterialSelected\": \"\",\n \"bevelSent\": \"\",\n \"requestSupplier\": \"\",\n \"ownManufacturing\": \"\",\n \"ownFrame\": \"\",\n \"contactLenses\": \"\",\n \"sameLensBothEyes\": \"\",\n \"useRxForContactology\": \"\",\n \"documentDate\": \"\",\n \"customerId\": \"\",\n \"patientInitials\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"orderTypeId\": \"\",\n \"optometricExamId\": \"\",\n \"contactLensExamId\": \"\",\n \"customerOrderId\": \"\",\n \"invoiceId\": \"\",\n \"supplierOrderId\": \"\",\n \"productionOrderId\": \"\",\n \"frameProductId\": \"\",\n \"frameType\": \"AA\",\n \"frameHorizontal\": \"\",\n \"frameVertical\": \"\",\n \"frameBridge\": \"\",\n \"frameBiggestDiameter\": \"\",\n \"frameEffectiveDiameter\": \"\",\n \"frameMechanicalDistance\": \"\",\n \"pantoscopicAngle\": \"\",\n \"panoramicAngle\": \"\",\n \"vertexDistance\": \"\",\n \"nearWorkingDistance\": \"\",\n \"eyeRotationCenter\": \"\",\n \"pupillaryDistance\": \"\",\n \"medianDistance\": \"\",\n \"frameFit\": \"\",\n \"cCode\": \"\",\n \"heightRightEye\": \"\",\n \"heightLeftEye\": \"\",\n \"edgeThickness\": \"\",\n \"specialBase\": \"\",\n \"maxDecentrationRightEye\": \"\",\n \"maxDecentrationLeftEye\": \"\",\n \"dominantEye\": \"NONE\",\n \"nvb\": \"\",\n \"rightLensProductId\": \"\",\n \"leftLensProductId\": \"\",\n \"recommendedLensTypeRightEye\": \"OCCUPATIONAL\",\n \"recommendedLensTypeLeftEye\": \"FAR\",\n \"rawMaterialRightEyeProductId\": \"\",\n \"rawMaterialLeftEyeProductId\": \"\",\n \"rightEye\": {\n \"id\": \"\",\n \"eye\": \"RIGHT\",\n \"lensType\": \"MULTIFOCAL\",\n \"crystalType\": \"\",\n \"sphere\": \"\",\n \"cylinder\": \"\",\n \"axis\": \"\",\n \"addition\": \"\",\n \"near\": \"\",\n \"prism\": \"\",\n \"base\": \"\",\n \"diameter\": \"\",\n \"baseCurve\": \"\",\n \"height\": \"\",\n \"nearMonocularPd\": \"\",\n \"farMonocularPd\": \"\",\n \"lotNumber\": \"\",\n \"invima\": \"\"\n },\n \"leftEye\": {\n \"id\": \"\",\n \"eye\": \"RIGHT\",\n \"lensType\": \"OCCUPATIONAL\",\n \"crystalType\": \"\",\n \"sphere\": \"\",\n \"cylinder\": \"\",\n \"axis\": \"\",\n \"addition\": \"\",\n \"near\": \"\",\n \"prism\": \"\",\n \"base\": \"\",\n \"diameter\": \"\",\n \"baseCurve\": \"\",\n \"height\": \"\",\n \"nearMonocularPd\": \"\",\n \"farMonocularPd\": \"\",\n \"lotNumber\": \"\",\n \"invima\": \"\"\n },\n \"rightEyeColorationProductId\": \"\",\n \"leftEyeColorationProductId\": \"\",\n \"rightEyeTreatmentProductId\": \"\",\n \"leftEyeTreatmentProductId\": \"\",\n \"rightEyeSupplementProductIds\": [\n \"\",\n \"\"\n ],\n \"leftEyeSupplementProductIds\": [\n \"\",\n \"\"\n ],\n \"rightEyeColoration\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"SUPPLEMENT\",\n \"sourceLineId\": \"\"\n },\n \"leftEyeColoration\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"SUPPLEMENT\",\n \"sourceLineId\": \"\"\n },\n \"rightEyeTreatment\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"TREATMENT\",\n \"sourceLineId\": \"\"\n },\n \"leftEyeTreatment\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"SUPPLEMENT\",\n \"sourceLineId\": \"\"\n },\n \"internalRef\": \"\",\n \"supplier\": \"\",\n \"notes\": \"\",\n \"notifyPatient\": \"\",\n \"ccode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "79b0d221-32da-4384-9b4c-8a18f9dc5569", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "optical-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Optical order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"assembled\": \"\",\n \"rawMaterialSelected\": \"\",\n \"bevelSent\": \"\",\n \"requestSupplier\": \"\",\n \"ownManufacturing\": \"\",\n \"ownFrame\": \"\",\n \"contactLenses\": \"\",\n \"sameLensBothEyes\": \"\",\n \"useRxForContactology\": \"\",\n \"documentDate\": \"\",\n \"customerId\": \"\",\n \"patientInitials\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"orderTypeId\": \"\",\n \"optometricExamId\": \"\",\n \"contactLensExamId\": \"\",\n \"customerOrderId\": \"\",\n \"invoiceId\": \"\",\n \"supplierOrderId\": \"\",\n \"productionOrderId\": \"\",\n \"frameProductId\": \"\",\n \"frameType\": \"AA\",\n \"frameHorizontal\": \"\",\n \"frameVertical\": \"\",\n \"frameBridge\": \"\",\n \"frameBiggestDiameter\": \"\",\n \"frameEffectiveDiameter\": \"\",\n \"frameMechanicalDistance\": \"\",\n \"pantoscopicAngle\": \"\",\n \"panoramicAngle\": \"\",\n \"vertexDistance\": \"\",\n \"nearWorkingDistance\": \"\",\n \"eyeRotationCenter\": \"\",\n \"pupillaryDistance\": \"\",\n \"medianDistance\": \"\",\n \"frameFit\": \"\",\n \"cCode\": \"\",\n \"heightRightEye\": \"\",\n \"heightLeftEye\": \"\",\n \"edgeThickness\": \"\",\n \"specialBase\": \"\",\n \"maxDecentrationRightEye\": \"\",\n \"maxDecentrationLeftEye\": \"\",\n \"dominantEye\": \"NONE\",\n \"nvb\": \"\",\n \"rightLensProductId\": \"\",\n \"leftLensProductId\": \"\",\n \"recommendedLensTypeRightEye\": \"OCCUPATIONAL\",\n \"recommendedLensTypeLeftEye\": \"FAR\",\n \"rawMaterialRightEyeProductId\": \"\",\n \"rawMaterialLeftEyeProductId\": \"\",\n \"rightEye\": {\n \"id\": \"\",\n \"eye\": \"RIGHT\",\n \"lensType\": \"MULTIFOCAL\",\n \"crystalType\": \"\",\n \"sphere\": \"\",\n \"cylinder\": \"\",\n \"axis\": \"\",\n \"addition\": \"\",\n \"near\": \"\",\n \"prism\": \"\",\n \"base\": \"\",\n \"diameter\": \"\",\n \"baseCurve\": \"\",\n \"height\": \"\",\n \"nearMonocularPd\": \"\",\n \"farMonocularPd\": \"\",\n \"lotNumber\": \"\",\n \"invima\": \"\"\n },\n \"leftEye\": {\n \"id\": \"\",\n \"eye\": \"RIGHT\",\n \"lensType\": \"OCCUPATIONAL\",\n \"crystalType\": \"\",\n \"sphere\": \"\",\n \"cylinder\": \"\",\n \"axis\": \"\",\n \"addition\": \"\",\n \"near\": \"\",\n \"prism\": \"\",\n \"base\": \"\",\n \"diameter\": \"\",\n \"baseCurve\": \"\",\n \"height\": \"\",\n \"nearMonocularPd\": \"\",\n \"farMonocularPd\": \"\",\n \"lotNumber\": \"\",\n \"invima\": \"\"\n },\n \"rightEyeColorationProductId\": \"\",\n \"leftEyeColorationProductId\": \"\",\n \"rightEyeTreatmentProductId\": \"\",\n \"leftEyeTreatmentProductId\": \"\",\n \"rightEyeSupplementProductIds\": [\n \"\",\n \"\"\n ],\n \"leftEyeSupplementProductIds\": [\n \"\",\n \"\"\n ],\n \"rightEyeColoration\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"SUPPLEMENT\",\n \"sourceLineId\": \"\"\n },\n \"leftEyeColoration\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"SUPPLEMENT\",\n \"sourceLineId\": \"\"\n },\n \"rightEyeTreatment\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"TREATMENT\",\n \"sourceLineId\": \"\"\n },\n \"leftEyeTreatment\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"SUPPLEMENT\",\n \"sourceLineId\": \"\"\n },\n \"internalRef\": \"\",\n \"supplier\": \"\",\n \"notes\": \"\",\n \"notifyPatient\": \"\",\n \"ccode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "53287f11-7d8b-4ebe-98c8-cb0312a63a80", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "optical-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Optical order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"assembled\": \"\",\n \"rawMaterialSelected\": \"\",\n \"bevelSent\": \"\",\n \"requestSupplier\": \"\",\n \"ownManufacturing\": \"\",\n \"ownFrame\": \"\",\n \"contactLenses\": \"\",\n \"sameLensBothEyes\": \"\",\n \"useRxForContactology\": \"\",\n \"documentDate\": \"\",\n \"customerId\": \"\",\n \"patientInitials\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"orderTypeId\": \"\",\n \"optometricExamId\": \"\",\n \"contactLensExamId\": \"\",\n \"customerOrderId\": \"\",\n \"invoiceId\": \"\",\n \"supplierOrderId\": \"\",\n \"productionOrderId\": \"\",\n \"frameProductId\": \"\",\n \"frameType\": \"AA\",\n \"frameHorizontal\": \"\",\n \"frameVertical\": \"\",\n \"frameBridge\": \"\",\n \"frameBiggestDiameter\": \"\",\n \"frameEffectiveDiameter\": \"\",\n \"frameMechanicalDistance\": \"\",\n \"pantoscopicAngle\": \"\",\n \"panoramicAngle\": \"\",\n \"vertexDistance\": \"\",\n \"nearWorkingDistance\": \"\",\n \"eyeRotationCenter\": \"\",\n \"pupillaryDistance\": \"\",\n \"medianDistance\": \"\",\n \"frameFit\": \"\",\n \"cCode\": \"\",\n \"heightRightEye\": \"\",\n \"heightLeftEye\": \"\",\n \"edgeThickness\": \"\",\n \"specialBase\": \"\",\n \"maxDecentrationRightEye\": \"\",\n \"maxDecentrationLeftEye\": \"\",\n \"dominantEye\": \"NONE\",\n \"nvb\": \"\",\n \"rightLensProductId\": \"\",\n \"leftLensProductId\": \"\",\n \"recommendedLensTypeRightEye\": \"OCCUPATIONAL\",\n \"recommendedLensTypeLeftEye\": \"FAR\",\n \"rawMaterialRightEyeProductId\": \"\",\n \"rawMaterialLeftEyeProductId\": \"\",\n \"rightEye\": {\n \"id\": \"\",\n \"eye\": \"RIGHT\",\n \"lensType\": \"MULTIFOCAL\",\n \"crystalType\": \"\",\n \"sphere\": \"\",\n \"cylinder\": \"\",\n \"axis\": \"\",\n \"addition\": \"\",\n \"near\": \"\",\n \"prism\": \"\",\n \"base\": \"\",\n \"diameter\": \"\",\n \"baseCurve\": \"\",\n \"height\": \"\",\n \"nearMonocularPd\": \"\",\n \"farMonocularPd\": \"\",\n \"lotNumber\": \"\",\n \"invima\": \"\"\n },\n \"leftEye\": {\n \"id\": \"\",\n \"eye\": \"RIGHT\",\n \"lensType\": \"OCCUPATIONAL\",\n \"crystalType\": \"\",\n \"sphere\": \"\",\n \"cylinder\": \"\",\n \"axis\": \"\",\n \"addition\": \"\",\n \"near\": \"\",\n \"prism\": \"\",\n \"base\": \"\",\n \"diameter\": \"\",\n \"baseCurve\": \"\",\n \"height\": \"\",\n \"nearMonocularPd\": \"\",\n \"farMonocularPd\": \"\",\n \"lotNumber\": \"\",\n \"invima\": \"\"\n },\n \"rightEyeColorationProductId\": \"\",\n \"leftEyeColorationProductId\": \"\",\n \"rightEyeTreatmentProductId\": \"\",\n \"leftEyeTreatmentProductId\": \"\",\n \"rightEyeSupplementProductIds\": [\n \"\",\n \"\"\n ],\n \"leftEyeSupplementProductIds\": [\n \"\",\n \"\"\n ],\n \"rightEyeColoration\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"SUPPLEMENT\",\n \"sourceLineId\": \"\"\n },\n \"leftEyeColoration\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"SUPPLEMENT\",\n \"sourceLineId\": \"\"\n },\n \"rightEyeTreatment\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"TREATMENT\",\n \"sourceLineId\": \"\"\n },\n \"leftEyeTreatment\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"SUPPLEMENT\",\n \"sourceLineId\": \"\"\n },\n \"internalRef\": \"\",\n \"supplier\": \"\",\n \"notes\": \"\",\n \"notifyPatient\": \"\",\n \"ccode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e94de2ab-aa85-4eb8-ae8d-7ce234928be1", "name": "Delete optical order", "request": { "name": "Delete optical order", "description": { "content": "Deletes an optical order. Send the `If-Match` header with the current ETag for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "optical-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Optical order ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "cb9d902e-7ece-4905-b853-5274160a62ca", "name": "Optical order deleted", "originalRequest": { "url": { "path": [ "api", "v2", "optical-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Optical order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ae4acf5e-13a6-4a81-90e7-11ccf03c7ff8", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "optical-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Optical order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2d2e2780-12d6-402a-8d40-9ddc5dc3fbf5", "name": "Authenticated user is missing the `BORRAR_ENCARGO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "optical-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Optical order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "337e139d-e73d-4b21-9bc8-f89cad24d9dd", "name": "Optical order not found", "originalRequest": { "url": { "path": [ "api", "v2", "optical-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Optical order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b4ffc801-ac82-4dfa-afd9-d597b34ac671", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "optical-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Optical order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0bb8ba8b-be3f-421c-9046-6b539677d568", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "optical-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Optical order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4cdda95c-9bd6-416c-b530-f913b8b4e54f", "name": "Merge-patch optical order", "request": { "name": "Merge-patch optical order", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "optical-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Optical order ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "1251cec9-5008-4ed5-bd18-13c0847d5d4a", "name": "Optical order patched", "originalRequest": { "url": { "path": [ "api", "v2", "optical-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Optical order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"documentType\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"documentStatusId\": \"\",\n \"documentStatusName\": \"\",\n \"assembled\": \"\",\n \"rawMaterialSelected\": \"\",\n \"bevelSent\": \"\",\n \"requestSupplier\": \"\",\n \"ownManufacturing\": \"\",\n \"ownFrame\": \"\",\n \"contactLenses\": \"\",\n \"sameLensBothEyes\": \"\",\n \"useRxForContactology\": \"\",\n \"documentDate\": \"\",\n \"firstPrintDate\": \"\",\n \"customerId\": \"\",\n \"customerName\": \"\",\n \"patientInitials\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"orderTypeId\": \"\",\n \"orderTypeName\": \"\",\n \"optometricExamId\": \"\",\n \"contactLensExamId\": \"\",\n \"customerOrderId\": \"\",\n \"invoiceId\": \"\",\n \"supplierOrderId\": \"\",\n \"productionOrderId\": \"\",\n \"frameShipmentTransferId\": \"\",\n \"bevelledLensTransferId\": \"\",\n \"finishedLensTransferId\": \"\",\n \"lastTraceId\": \"\",\n \"frameProductId\": \"\",\n \"frameProductName\": \"\",\n \"frameType\": \"AA\",\n \"frameHorizontal\": \"\",\n \"frameVertical\": \"\",\n \"frameBridge\": \"\",\n \"frameBiggestDiameter\": \"\",\n \"frameEffectiveDiameter\": \"\",\n \"frameMechanicalDistance\": \"\",\n \"pantoscopicAngle\": \"\",\n \"panoramicAngle\": \"\",\n \"vertexDistance\": \"\",\n \"nearWorkingDistance\": \"\",\n \"eyeRotationCenter\": \"\",\n \"pupillaryDistance\": \"\",\n \"medianDistance\": \"\",\n \"frameFit\": \"\",\n \"cCode\": \"\",\n \"heightRightEye\": \"\",\n \"heightLeftEye\": \"\",\n \"edgeThickness\": \"\",\n \"specialBase\": \"\",\n \"maxDecentrationRightEye\": \"\",\n \"maxDecentrationLeftEye\": \"\",\n \"dominantEye\": \"NONE\",\n \"nvb\": \"\",\n \"rightLensProductId\": \"\",\n \"rightLensProductName\": \"\",\n \"leftLensProductId\": \"\",\n \"leftLensProductName\": \"\",\n \"recommendedLensTypeRightEye\": \"OCCUPATIONAL\",\n \"recommendedLensTypeLeftEye\": \"BIFOCAL\",\n \"rawMaterialRightEyeProductId\": \"\",\n \"rawMaterialLeftEyeProductId\": \"\",\n \"rightEye\": {\n \"id\": \"\",\n \"eye\": \"RIGHT\",\n \"lensType\": \"PROGRESSIVE\",\n \"crystalType\": \"\",\n \"sphere\": \"\",\n \"cylinder\": \"\",\n \"axis\": \"\",\n \"addition\": \"\",\n \"near\": \"\",\n \"prism\": \"\",\n \"base\": \"\",\n \"diameter\": \"\",\n \"baseCurve\": \"\",\n \"height\": \"\",\n \"nearMonocularPd\": \"\",\n \"farMonocularPd\": \"\",\n \"lotNumber\": \"\",\n \"invima\": \"\"\n },\n \"leftEye\": {\n \"id\": \"\",\n \"eye\": \"RIGHT\",\n \"lensType\": \"INTERMEDIATE\",\n \"crystalType\": \"\",\n \"sphere\": \"\",\n \"cylinder\": \"\",\n \"axis\": \"\",\n \"addition\": \"\",\n \"near\": \"\",\n \"prism\": \"\",\n \"base\": \"\",\n \"diameter\": \"\",\n \"baseCurve\": \"\",\n \"height\": \"\",\n \"nearMonocularPd\": \"\",\n \"farMonocularPd\": \"\",\n \"lotNumber\": \"\",\n \"invima\": \"\"\n },\n \"rightEyeColoration\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"TREATMENT\",\n \"sourceLineId\": \"\"\n },\n \"leftEyeColoration\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"COLORATION\",\n \"sourceLineId\": \"\"\n },\n \"rightEyeTreatment\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"COLORATION\",\n \"sourceLineId\": \"\"\n },\n \"leftEyeTreatment\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"TREATMENT\",\n \"sourceLineId\": \"\"\n },\n \"rightEyeSupplements\": [\n {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"COLORATION\",\n \"sourceLineId\": \"\"\n },\n {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"TREATMENT\",\n \"sourceLineId\": \"\"\n }\n ],\n \"leftEyeSupplements\": [\n {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"SUPPLEMENT\",\n \"sourceLineId\": \"\"\n },\n {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"TREATMENT\",\n \"sourceLineId\": \"\"\n }\n ],\n \"internalRef\": \"\",\n \"supplier\": \"\",\n \"notes\": \"\",\n \"notificationsSent\": \"\",\n \"notifyPatient\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\",\n \"sourceSystem\": \"\",\n \"ccode\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ff9348d0-f190-4cad-b9be-80d59c6e29f2", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details. Also returned for malformed merge-patch payloads.", "originalRequest": { "url": { "path": [ "api", "v2", "optical-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Optical order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6b0cf5d8-c135-42f5-a861-99df1580cb84", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "optical-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Optical order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3c4b8e81-c3ad-450e-9b98-1c285f00d02b", "name": "Authenticated user is missing the `EDITAR_ENCARGO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "optical-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Optical order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0425f28c-443d-48cf-8d3d-e26feb868b84", "name": "Optical order not found", "originalRequest": { "url": { "path": [ "api", "v2", "optical-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Optical order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "afed8a7b-794c-4108-8477-b2c5e5b66c73", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "optical-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Optical order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5b03184b-1f0d-4644-aa2f-a6dac7a123f3", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "optical-orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Optical order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "3272a45c-f269-4629-9968-cf9e77dfc626", "name": "List optical orders", "request": { "name": "List optical orders", "description": { "content": "Returns a paginated list of optical orders with envelope `{data, totalCount, skip, limit, hasMore}`. Supports optional RSQL `filter`, `sort` (default `lastModifiedAt:desc`), `skip`/`limit` pagination and `modifiedAfter`/`modifiedBefore` bookends. Limit is capped at 200; skip is clamped to >= 0. The list payload does NOT include the nested per-eye prescription or lens add-ons; fetch the order by id for the full shape.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "optical-orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "77151260-918d-4778-9f69-18c745ecfe32", "name": "Page of optical orders", "originalRequest": { "url": { "path": [ "api", "v2", "optical-orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7ef5af68-4917-4e0e-acca-175c1cf2870c", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "optical-orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a5583511-46e7-4c16-bd7a-f0eec3dabace", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "optical-orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1792dcbc-520d-46af-a438-9b86bb79e077", "name": "Authenticated user is missing the `VER_ENCARGO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "optical-orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1c18cd8d-c258-4e7f-af67-aa688341b095", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "optical-orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e9a9f002-82b3-4ffd-b219-5d66154e075a", "name": "Create optical order", "request": { "name": "Create optical order", "description": { "content": "Creates a new optical order with header fields and the optional per-eye prescription. Business logic (stock reservations, production routing) runs in the legacy WAR via the internal commands gateway.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "optical-orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"assembled\": \"\",\n \"rawMaterialSelected\": \"\",\n \"bevelSent\": \"\",\n \"requestSupplier\": \"\",\n \"ownManufacturing\": \"\",\n \"ownFrame\": \"\",\n \"contactLenses\": \"\",\n \"sameLensBothEyes\": \"\",\n \"useRxForContactology\": \"\",\n \"documentDate\": \"\",\n \"customerId\": \"\",\n \"patientInitials\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"orderTypeId\": \"\",\n \"optometricExamId\": \"\",\n \"contactLensExamId\": \"\",\n \"customerOrderId\": \"\",\n \"invoiceId\": \"\",\n \"supplierOrderId\": \"\",\n \"productionOrderId\": \"\",\n \"frameProductId\": \"\",\n \"frameType\": \"AA\",\n \"frameHorizontal\": \"\",\n \"frameVertical\": \"\",\n \"frameBridge\": \"\",\n \"frameBiggestDiameter\": \"\",\n \"frameEffectiveDiameter\": \"\",\n \"frameMechanicalDistance\": \"\",\n \"pantoscopicAngle\": \"\",\n \"panoramicAngle\": \"\",\n \"vertexDistance\": \"\",\n \"nearWorkingDistance\": \"\",\n \"eyeRotationCenter\": \"\",\n \"pupillaryDistance\": \"\",\n \"medianDistance\": \"\",\n \"frameFit\": \"\",\n \"cCode\": \"\",\n \"heightRightEye\": \"\",\n \"heightLeftEye\": \"\",\n \"edgeThickness\": \"\",\n \"specialBase\": \"\",\n \"maxDecentrationRightEye\": \"\",\n \"maxDecentrationLeftEye\": \"\",\n \"dominantEye\": \"NONE\",\n \"nvb\": \"\",\n \"rightLensProductId\": \"\",\n \"leftLensProductId\": \"\",\n \"recommendedLensTypeRightEye\": \"OCCUPATIONAL\",\n \"recommendedLensTypeLeftEye\": \"FAR\",\n \"rawMaterialRightEyeProductId\": \"\",\n \"rawMaterialLeftEyeProductId\": \"\",\n \"rightEye\": {\n \"id\": \"\",\n \"eye\": \"RIGHT\",\n \"lensType\": \"MULTIFOCAL\",\n \"crystalType\": \"\",\n \"sphere\": \"\",\n \"cylinder\": \"\",\n \"axis\": \"\",\n \"addition\": \"\",\n \"near\": \"\",\n \"prism\": \"\",\n \"base\": \"\",\n \"diameter\": \"\",\n \"baseCurve\": \"\",\n \"height\": \"\",\n \"nearMonocularPd\": \"\",\n \"farMonocularPd\": \"\",\n \"lotNumber\": \"\",\n \"invima\": \"\"\n },\n \"leftEye\": {\n \"id\": \"\",\n \"eye\": \"RIGHT\",\n \"lensType\": \"OCCUPATIONAL\",\n \"crystalType\": \"\",\n \"sphere\": \"\",\n \"cylinder\": \"\",\n \"axis\": \"\",\n \"addition\": \"\",\n \"near\": \"\",\n \"prism\": \"\",\n \"base\": \"\",\n \"diameter\": \"\",\n \"baseCurve\": \"\",\n \"height\": \"\",\n \"nearMonocularPd\": \"\",\n \"farMonocularPd\": \"\",\n \"lotNumber\": \"\",\n \"invima\": \"\"\n },\n \"rightEyeColorationProductId\": \"\",\n \"leftEyeColorationProductId\": \"\",\n \"rightEyeTreatmentProductId\": \"\",\n \"leftEyeTreatmentProductId\": \"\",\n \"rightEyeSupplementProductIds\": [\n \"\",\n \"\"\n ],\n \"leftEyeSupplementProductIds\": [\n \"\",\n \"\"\n ],\n \"rightEyeColoration\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"SUPPLEMENT\",\n \"sourceLineId\": \"\"\n },\n \"leftEyeColoration\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"SUPPLEMENT\",\n \"sourceLineId\": \"\"\n },\n \"rightEyeTreatment\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"TREATMENT\",\n \"sourceLineId\": \"\"\n },\n \"leftEyeTreatment\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"SUPPLEMENT\",\n \"sourceLineId\": \"\"\n },\n \"internalRef\": \"\",\n \"supplier\": \"\",\n \"notes\": \"\",\n \"notifyPatient\": \"\",\n \"ccode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "ff541035-97fe-4d1c-9fa4-9eaa6a8a3d8c", "name": "Optical order created", "originalRequest": { "url": { "path": [ "api", "v2", "optical-orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"assembled\": \"\",\n \"rawMaterialSelected\": \"\",\n \"bevelSent\": \"\",\n \"requestSupplier\": \"\",\n \"ownManufacturing\": \"\",\n \"ownFrame\": \"\",\n \"contactLenses\": \"\",\n \"sameLensBothEyes\": \"\",\n \"useRxForContactology\": \"\",\n \"documentDate\": \"\",\n \"customerId\": \"\",\n \"patientInitials\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"orderTypeId\": \"\",\n \"optometricExamId\": \"\",\n \"contactLensExamId\": \"\",\n \"customerOrderId\": \"\",\n \"invoiceId\": \"\",\n \"supplierOrderId\": \"\",\n \"productionOrderId\": \"\",\n \"frameProductId\": \"\",\n \"frameType\": \"AA\",\n \"frameHorizontal\": \"\",\n \"frameVertical\": \"\",\n \"frameBridge\": \"\",\n \"frameBiggestDiameter\": \"\",\n \"frameEffectiveDiameter\": \"\",\n \"frameMechanicalDistance\": \"\",\n \"pantoscopicAngle\": \"\",\n \"panoramicAngle\": \"\",\n \"vertexDistance\": \"\",\n \"nearWorkingDistance\": \"\",\n \"eyeRotationCenter\": \"\",\n \"pupillaryDistance\": \"\",\n \"medianDistance\": \"\",\n \"frameFit\": \"\",\n \"cCode\": \"\",\n \"heightRightEye\": \"\",\n \"heightLeftEye\": \"\",\n \"edgeThickness\": \"\",\n \"specialBase\": \"\",\n \"maxDecentrationRightEye\": \"\",\n \"maxDecentrationLeftEye\": \"\",\n \"dominantEye\": \"NONE\",\n \"nvb\": \"\",\n \"rightLensProductId\": \"\",\n \"leftLensProductId\": \"\",\n \"recommendedLensTypeRightEye\": \"OCCUPATIONAL\",\n \"recommendedLensTypeLeftEye\": \"FAR\",\n \"rawMaterialRightEyeProductId\": \"\",\n \"rawMaterialLeftEyeProductId\": \"\",\n \"rightEye\": {\n \"id\": \"\",\n \"eye\": \"RIGHT\",\n \"lensType\": \"MULTIFOCAL\",\n \"crystalType\": \"\",\n \"sphere\": \"\",\n \"cylinder\": \"\",\n \"axis\": \"\",\n \"addition\": \"\",\n \"near\": \"\",\n \"prism\": \"\",\n \"base\": \"\",\n \"diameter\": \"\",\n \"baseCurve\": \"\",\n \"height\": \"\",\n \"nearMonocularPd\": \"\",\n \"farMonocularPd\": \"\",\n \"lotNumber\": \"\",\n \"invima\": \"\"\n },\n \"leftEye\": {\n \"id\": \"\",\n \"eye\": \"RIGHT\",\n \"lensType\": \"OCCUPATIONAL\",\n \"crystalType\": \"\",\n \"sphere\": \"\",\n \"cylinder\": \"\",\n \"axis\": \"\",\n \"addition\": \"\",\n \"near\": \"\",\n \"prism\": \"\",\n \"base\": \"\",\n \"diameter\": \"\",\n \"baseCurve\": \"\",\n \"height\": \"\",\n \"nearMonocularPd\": \"\",\n \"farMonocularPd\": \"\",\n \"lotNumber\": \"\",\n \"invima\": \"\"\n },\n \"rightEyeColorationProductId\": \"\",\n \"leftEyeColorationProductId\": \"\",\n \"rightEyeTreatmentProductId\": \"\",\n \"leftEyeTreatmentProductId\": \"\",\n \"rightEyeSupplementProductIds\": [\n \"\",\n \"\"\n ],\n \"leftEyeSupplementProductIds\": [\n \"\",\n \"\"\n ],\n \"rightEyeColoration\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"SUPPLEMENT\",\n \"sourceLineId\": \"\"\n },\n \"leftEyeColoration\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"SUPPLEMENT\",\n \"sourceLineId\": \"\"\n },\n \"rightEyeTreatment\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"TREATMENT\",\n \"sourceLineId\": \"\"\n },\n \"leftEyeTreatment\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"SUPPLEMENT\",\n \"sourceLineId\": \"\"\n },\n \"internalRef\": \"\",\n \"supplier\": \"\",\n \"notes\": \"\",\n \"notifyPatient\": \"\",\n \"ccode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"documentType\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"documentStatusId\": \"\",\n \"documentStatusName\": \"\",\n \"assembled\": \"\",\n \"rawMaterialSelected\": \"\",\n \"bevelSent\": \"\",\n \"requestSupplier\": \"\",\n \"ownManufacturing\": \"\",\n \"ownFrame\": \"\",\n \"contactLenses\": \"\",\n \"sameLensBothEyes\": \"\",\n \"useRxForContactology\": \"\",\n \"documentDate\": \"\",\n \"firstPrintDate\": \"\",\n \"customerId\": \"\",\n \"customerName\": \"\",\n \"patientInitials\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"orderTypeId\": \"\",\n \"orderTypeName\": \"\",\n \"optometricExamId\": \"\",\n \"contactLensExamId\": \"\",\n \"customerOrderId\": \"\",\n \"invoiceId\": \"\",\n \"supplierOrderId\": \"\",\n \"productionOrderId\": \"\",\n \"frameShipmentTransferId\": \"\",\n \"bevelledLensTransferId\": \"\",\n \"finishedLensTransferId\": \"\",\n \"lastTraceId\": \"\",\n \"frameProductId\": \"\",\n \"frameProductName\": \"\",\n \"frameType\": \"AA\",\n \"frameHorizontal\": \"\",\n \"frameVertical\": \"\",\n \"frameBridge\": \"\",\n \"frameBiggestDiameter\": \"\",\n \"frameEffectiveDiameter\": \"\",\n \"frameMechanicalDistance\": \"\",\n \"pantoscopicAngle\": \"\",\n \"panoramicAngle\": \"\",\n \"vertexDistance\": \"\",\n \"nearWorkingDistance\": \"\",\n \"eyeRotationCenter\": \"\",\n \"pupillaryDistance\": \"\",\n \"medianDistance\": \"\",\n \"frameFit\": \"\",\n \"cCode\": \"\",\n \"heightRightEye\": \"\",\n \"heightLeftEye\": \"\",\n \"edgeThickness\": \"\",\n \"specialBase\": \"\",\n \"maxDecentrationRightEye\": \"\",\n \"maxDecentrationLeftEye\": \"\",\n \"dominantEye\": \"NONE\",\n \"nvb\": \"\",\n \"rightLensProductId\": \"\",\n \"rightLensProductName\": \"\",\n \"leftLensProductId\": \"\",\n \"leftLensProductName\": \"\",\n \"recommendedLensTypeRightEye\": \"OCCUPATIONAL\",\n \"recommendedLensTypeLeftEye\": \"BIFOCAL\",\n \"rawMaterialRightEyeProductId\": \"\",\n \"rawMaterialLeftEyeProductId\": \"\",\n \"rightEye\": {\n \"id\": \"\",\n \"eye\": \"RIGHT\",\n \"lensType\": \"PROGRESSIVE\",\n \"crystalType\": \"\",\n \"sphere\": \"\",\n \"cylinder\": \"\",\n \"axis\": \"\",\n \"addition\": \"\",\n \"near\": \"\",\n \"prism\": \"\",\n \"base\": \"\",\n \"diameter\": \"\",\n \"baseCurve\": \"\",\n \"height\": \"\",\n \"nearMonocularPd\": \"\",\n \"farMonocularPd\": \"\",\n \"lotNumber\": \"\",\n \"invima\": \"\"\n },\n \"leftEye\": {\n \"id\": \"\",\n \"eye\": \"RIGHT\",\n \"lensType\": \"INTERMEDIATE\",\n \"crystalType\": \"\",\n \"sphere\": \"\",\n \"cylinder\": \"\",\n \"axis\": \"\",\n \"addition\": \"\",\n \"near\": \"\",\n \"prism\": \"\",\n \"base\": \"\",\n \"diameter\": \"\",\n \"baseCurve\": \"\",\n \"height\": \"\",\n \"nearMonocularPd\": \"\",\n \"farMonocularPd\": \"\",\n \"lotNumber\": \"\",\n \"invima\": \"\"\n },\n \"rightEyeColoration\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"TREATMENT\",\n \"sourceLineId\": \"\"\n },\n \"leftEyeColoration\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"COLORATION\",\n \"sourceLineId\": \"\"\n },\n \"rightEyeTreatment\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"COLORATION\",\n \"sourceLineId\": \"\"\n },\n \"leftEyeTreatment\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"TREATMENT\",\n \"sourceLineId\": \"\"\n },\n \"rightEyeSupplements\": [\n {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"COLORATION\",\n \"sourceLineId\": \"\"\n },\n {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"TREATMENT\",\n \"sourceLineId\": \"\"\n }\n ],\n \"leftEyeSupplements\": [\n {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"SUPPLEMENT\",\n \"sourceLineId\": \"\"\n },\n {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"TREATMENT\",\n \"sourceLineId\": \"\"\n }\n ],\n \"internalRef\": \"\",\n \"supplier\": \"\",\n \"notes\": \"\",\n \"notificationsSent\": \"\",\n \"notifyPatient\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\",\n \"sourceSystem\": \"\",\n \"ccode\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "aa879362-3feb-4ef0-8046-a749d529c638", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "optical-orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"assembled\": \"\",\n \"rawMaterialSelected\": \"\",\n \"bevelSent\": \"\",\n \"requestSupplier\": \"\",\n \"ownManufacturing\": \"\",\n \"ownFrame\": \"\",\n \"contactLenses\": \"\",\n \"sameLensBothEyes\": \"\",\n \"useRxForContactology\": \"\",\n \"documentDate\": \"\",\n \"customerId\": \"\",\n \"patientInitials\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"orderTypeId\": \"\",\n \"optometricExamId\": \"\",\n \"contactLensExamId\": \"\",\n \"customerOrderId\": \"\",\n \"invoiceId\": \"\",\n \"supplierOrderId\": \"\",\n \"productionOrderId\": \"\",\n \"frameProductId\": \"\",\n \"frameType\": \"AA\",\n \"frameHorizontal\": \"\",\n \"frameVertical\": \"\",\n \"frameBridge\": \"\",\n \"frameBiggestDiameter\": \"\",\n \"frameEffectiveDiameter\": \"\",\n \"frameMechanicalDistance\": \"\",\n \"pantoscopicAngle\": \"\",\n \"panoramicAngle\": \"\",\n \"vertexDistance\": \"\",\n \"nearWorkingDistance\": \"\",\n \"eyeRotationCenter\": \"\",\n \"pupillaryDistance\": \"\",\n \"medianDistance\": \"\",\n \"frameFit\": \"\",\n \"cCode\": \"\",\n \"heightRightEye\": \"\",\n \"heightLeftEye\": \"\",\n \"edgeThickness\": \"\",\n \"specialBase\": \"\",\n \"maxDecentrationRightEye\": \"\",\n \"maxDecentrationLeftEye\": \"\",\n \"dominantEye\": \"NONE\",\n \"nvb\": \"\",\n \"rightLensProductId\": \"\",\n \"leftLensProductId\": \"\",\n \"recommendedLensTypeRightEye\": \"OCCUPATIONAL\",\n \"recommendedLensTypeLeftEye\": \"FAR\",\n \"rawMaterialRightEyeProductId\": \"\",\n \"rawMaterialLeftEyeProductId\": \"\",\n \"rightEye\": {\n \"id\": \"\",\n \"eye\": \"RIGHT\",\n \"lensType\": \"MULTIFOCAL\",\n \"crystalType\": \"\",\n \"sphere\": \"\",\n \"cylinder\": \"\",\n \"axis\": \"\",\n \"addition\": \"\",\n \"near\": \"\",\n \"prism\": \"\",\n \"base\": \"\",\n \"diameter\": \"\",\n \"baseCurve\": \"\",\n \"height\": \"\",\n \"nearMonocularPd\": \"\",\n \"farMonocularPd\": \"\",\n \"lotNumber\": \"\",\n \"invima\": \"\"\n },\n \"leftEye\": {\n \"id\": \"\",\n \"eye\": \"RIGHT\",\n \"lensType\": \"OCCUPATIONAL\",\n \"crystalType\": \"\",\n \"sphere\": \"\",\n \"cylinder\": \"\",\n \"axis\": \"\",\n \"addition\": \"\",\n \"near\": \"\",\n \"prism\": \"\",\n \"base\": \"\",\n \"diameter\": \"\",\n \"baseCurve\": \"\",\n \"height\": \"\",\n \"nearMonocularPd\": \"\",\n \"farMonocularPd\": \"\",\n \"lotNumber\": \"\",\n \"invima\": \"\"\n },\n \"rightEyeColorationProductId\": \"\",\n \"leftEyeColorationProductId\": \"\",\n \"rightEyeTreatmentProductId\": \"\",\n \"leftEyeTreatmentProductId\": \"\",\n \"rightEyeSupplementProductIds\": [\n \"\",\n \"\"\n ],\n \"leftEyeSupplementProductIds\": [\n \"\",\n \"\"\n ],\n \"rightEyeColoration\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"SUPPLEMENT\",\n \"sourceLineId\": \"\"\n },\n \"leftEyeColoration\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"SUPPLEMENT\",\n \"sourceLineId\": \"\"\n },\n \"rightEyeTreatment\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"TREATMENT\",\n \"sourceLineId\": \"\"\n },\n \"leftEyeTreatment\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"SUPPLEMENT\",\n \"sourceLineId\": \"\"\n },\n \"internalRef\": \"\",\n \"supplier\": \"\",\n \"notes\": \"\",\n \"notifyPatient\": \"\",\n \"ccode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "48d3340a-0f1e-4b45-9e33-7432b1894210", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "optical-orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"assembled\": \"\",\n \"rawMaterialSelected\": \"\",\n \"bevelSent\": \"\",\n \"requestSupplier\": \"\",\n \"ownManufacturing\": \"\",\n \"ownFrame\": \"\",\n \"contactLenses\": \"\",\n \"sameLensBothEyes\": \"\",\n \"useRxForContactology\": \"\",\n \"documentDate\": \"\",\n \"customerId\": \"\",\n \"patientInitials\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"orderTypeId\": \"\",\n \"optometricExamId\": \"\",\n \"contactLensExamId\": \"\",\n \"customerOrderId\": \"\",\n \"invoiceId\": \"\",\n \"supplierOrderId\": \"\",\n \"productionOrderId\": \"\",\n \"frameProductId\": \"\",\n \"frameType\": \"AA\",\n \"frameHorizontal\": \"\",\n \"frameVertical\": \"\",\n \"frameBridge\": \"\",\n \"frameBiggestDiameter\": \"\",\n \"frameEffectiveDiameter\": \"\",\n \"frameMechanicalDistance\": \"\",\n \"pantoscopicAngle\": \"\",\n \"panoramicAngle\": \"\",\n \"vertexDistance\": \"\",\n \"nearWorkingDistance\": \"\",\n \"eyeRotationCenter\": \"\",\n \"pupillaryDistance\": \"\",\n \"medianDistance\": \"\",\n \"frameFit\": \"\",\n \"cCode\": \"\",\n \"heightRightEye\": \"\",\n \"heightLeftEye\": \"\",\n \"edgeThickness\": \"\",\n \"specialBase\": \"\",\n \"maxDecentrationRightEye\": \"\",\n \"maxDecentrationLeftEye\": \"\",\n \"dominantEye\": \"NONE\",\n \"nvb\": \"\",\n \"rightLensProductId\": \"\",\n \"leftLensProductId\": \"\",\n \"recommendedLensTypeRightEye\": \"OCCUPATIONAL\",\n \"recommendedLensTypeLeftEye\": \"FAR\",\n \"rawMaterialRightEyeProductId\": \"\",\n \"rawMaterialLeftEyeProductId\": \"\",\n \"rightEye\": {\n \"id\": \"\",\n \"eye\": \"RIGHT\",\n \"lensType\": \"MULTIFOCAL\",\n \"crystalType\": \"\",\n \"sphere\": \"\",\n \"cylinder\": \"\",\n \"axis\": \"\",\n \"addition\": \"\",\n \"near\": \"\",\n \"prism\": \"\",\n \"base\": \"\",\n \"diameter\": \"\",\n \"baseCurve\": \"\",\n \"height\": \"\",\n \"nearMonocularPd\": \"\",\n \"farMonocularPd\": \"\",\n \"lotNumber\": \"\",\n \"invima\": \"\"\n },\n \"leftEye\": {\n \"id\": \"\",\n \"eye\": \"RIGHT\",\n \"lensType\": \"OCCUPATIONAL\",\n \"crystalType\": \"\",\n \"sphere\": \"\",\n \"cylinder\": \"\",\n \"axis\": \"\",\n \"addition\": \"\",\n \"near\": \"\",\n \"prism\": \"\",\n \"base\": \"\",\n \"diameter\": \"\",\n \"baseCurve\": \"\",\n \"height\": \"\",\n \"nearMonocularPd\": \"\",\n \"farMonocularPd\": \"\",\n \"lotNumber\": \"\",\n \"invima\": \"\"\n },\n \"rightEyeColorationProductId\": \"\",\n \"leftEyeColorationProductId\": \"\",\n \"rightEyeTreatmentProductId\": \"\",\n \"leftEyeTreatmentProductId\": \"\",\n \"rightEyeSupplementProductIds\": [\n \"\",\n \"\"\n ],\n \"leftEyeSupplementProductIds\": [\n \"\",\n \"\"\n ],\n \"rightEyeColoration\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"SUPPLEMENT\",\n \"sourceLineId\": \"\"\n },\n \"leftEyeColoration\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"SUPPLEMENT\",\n \"sourceLineId\": \"\"\n },\n \"rightEyeTreatment\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"TREATMENT\",\n \"sourceLineId\": \"\"\n },\n \"leftEyeTreatment\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"SUPPLEMENT\",\n \"sourceLineId\": \"\"\n },\n \"internalRef\": \"\",\n \"supplier\": \"\",\n \"notes\": \"\",\n \"notifyPatient\": \"\",\n \"ccode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cdbb2b72-8f30-4ee4-94a9-d1df1e120653", "name": "Authenticated user is missing the `CREAR_ENCARGO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "optical-orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"assembled\": \"\",\n \"rawMaterialSelected\": \"\",\n \"bevelSent\": \"\",\n \"requestSupplier\": \"\",\n \"ownManufacturing\": \"\",\n \"ownFrame\": \"\",\n \"contactLenses\": \"\",\n \"sameLensBothEyes\": \"\",\n \"useRxForContactology\": \"\",\n \"documentDate\": \"\",\n \"customerId\": \"\",\n \"patientInitials\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"orderTypeId\": \"\",\n \"optometricExamId\": \"\",\n \"contactLensExamId\": \"\",\n \"customerOrderId\": \"\",\n \"invoiceId\": \"\",\n \"supplierOrderId\": \"\",\n \"productionOrderId\": \"\",\n \"frameProductId\": \"\",\n \"frameType\": \"AA\",\n \"frameHorizontal\": \"\",\n \"frameVertical\": \"\",\n \"frameBridge\": \"\",\n \"frameBiggestDiameter\": \"\",\n \"frameEffectiveDiameter\": \"\",\n \"frameMechanicalDistance\": \"\",\n \"pantoscopicAngle\": \"\",\n \"panoramicAngle\": \"\",\n \"vertexDistance\": \"\",\n \"nearWorkingDistance\": \"\",\n \"eyeRotationCenter\": \"\",\n \"pupillaryDistance\": \"\",\n \"medianDistance\": \"\",\n \"frameFit\": \"\",\n \"cCode\": \"\",\n \"heightRightEye\": \"\",\n \"heightLeftEye\": \"\",\n \"edgeThickness\": \"\",\n \"specialBase\": \"\",\n \"maxDecentrationRightEye\": \"\",\n \"maxDecentrationLeftEye\": \"\",\n \"dominantEye\": \"NONE\",\n \"nvb\": \"\",\n \"rightLensProductId\": \"\",\n \"leftLensProductId\": \"\",\n \"recommendedLensTypeRightEye\": \"OCCUPATIONAL\",\n \"recommendedLensTypeLeftEye\": \"FAR\",\n \"rawMaterialRightEyeProductId\": \"\",\n \"rawMaterialLeftEyeProductId\": \"\",\n \"rightEye\": {\n \"id\": \"\",\n \"eye\": \"RIGHT\",\n \"lensType\": \"MULTIFOCAL\",\n \"crystalType\": \"\",\n \"sphere\": \"\",\n \"cylinder\": \"\",\n \"axis\": \"\",\n \"addition\": \"\",\n \"near\": \"\",\n \"prism\": \"\",\n \"base\": \"\",\n \"diameter\": \"\",\n \"baseCurve\": \"\",\n \"height\": \"\",\n \"nearMonocularPd\": \"\",\n \"farMonocularPd\": \"\",\n \"lotNumber\": \"\",\n \"invima\": \"\"\n },\n \"leftEye\": {\n \"id\": \"\",\n \"eye\": \"RIGHT\",\n \"lensType\": \"OCCUPATIONAL\",\n \"crystalType\": \"\",\n \"sphere\": \"\",\n \"cylinder\": \"\",\n \"axis\": \"\",\n \"addition\": \"\",\n \"near\": \"\",\n \"prism\": \"\",\n \"base\": \"\",\n \"diameter\": \"\",\n \"baseCurve\": \"\",\n \"height\": \"\",\n \"nearMonocularPd\": \"\",\n \"farMonocularPd\": \"\",\n \"lotNumber\": \"\",\n \"invima\": \"\"\n },\n \"rightEyeColorationProductId\": \"\",\n \"leftEyeColorationProductId\": \"\",\n \"rightEyeTreatmentProductId\": \"\",\n \"leftEyeTreatmentProductId\": \"\",\n \"rightEyeSupplementProductIds\": [\n \"\",\n \"\"\n ],\n \"leftEyeSupplementProductIds\": [\n \"\",\n \"\"\n ],\n \"rightEyeColoration\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"SUPPLEMENT\",\n \"sourceLineId\": \"\"\n },\n \"leftEyeColoration\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"SUPPLEMENT\",\n \"sourceLineId\": \"\"\n },\n \"rightEyeTreatment\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"TREATMENT\",\n \"sourceLineId\": \"\"\n },\n \"leftEyeTreatment\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"SUPPLEMENT\",\n \"sourceLineId\": \"\"\n },\n \"internalRef\": \"\",\n \"supplier\": \"\",\n \"notes\": \"\",\n \"notifyPatient\": \"\",\n \"ccode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e66bc0f5-fb11-4c38-84fd-c30cec8bc3b4", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "optical-orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"documentStatusId\": \"\",\n \"assembled\": \"\",\n \"rawMaterialSelected\": \"\",\n \"bevelSent\": \"\",\n \"requestSupplier\": \"\",\n \"ownManufacturing\": \"\",\n \"ownFrame\": \"\",\n \"contactLenses\": \"\",\n \"sameLensBothEyes\": \"\",\n \"useRxForContactology\": \"\",\n \"documentDate\": \"\",\n \"customerId\": \"\",\n \"patientInitials\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"orderTypeId\": \"\",\n \"optometricExamId\": \"\",\n \"contactLensExamId\": \"\",\n \"customerOrderId\": \"\",\n \"invoiceId\": \"\",\n \"supplierOrderId\": \"\",\n \"productionOrderId\": \"\",\n \"frameProductId\": \"\",\n \"frameType\": \"AA\",\n \"frameHorizontal\": \"\",\n \"frameVertical\": \"\",\n \"frameBridge\": \"\",\n \"frameBiggestDiameter\": \"\",\n \"frameEffectiveDiameter\": \"\",\n \"frameMechanicalDistance\": \"\",\n \"pantoscopicAngle\": \"\",\n \"panoramicAngle\": \"\",\n \"vertexDistance\": \"\",\n \"nearWorkingDistance\": \"\",\n \"eyeRotationCenter\": \"\",\n \"pupillaryDistance\": \"\",\n \"medianDistance\": \"\",\n \"frameFit\": \"\",\n \"cCode\": \"\",\n \"heightRightEye\": \"\",\n \"heightLeftEye\": \"\",\n \"edgeThickness\": \"\",\n \"specialBase\": \"\",\n \"maxDecentrationRightEye\": \"\",\n \"maxDecentrationLeftEye\": \"\",\n \"dominantEye\": \"NONE\",\n \"nvb\": \"\",\n \"rightLensProductId\": \"\",\n \"leftLensProductId\": \"\",\n \"recommendedLensTypeRightEye\": \"OCCUPATIONAL\",\n \"recommendedLensTypeLeftEye\": \"FAR\",\n \"rawMaterialRightEyeProductId\": \"\",\n \"rawMaterialLeftEyeProductId\": \"\",\n \"rightEye\": {\n \"id\": \"\",\n \"eye\": \"RIGHT\",\n \"lensType\": \"MULTIFOCAL\",\n \"crystalType\": \"\",\n \"sphere\": \"\",\n \"cylinder\": \"\",\n \"axis\": \"\",\n \"addition\": \"\",\n \"near\": \"\",\n \"prism\": \"\",\n \"base\": \"\",\n \"diameter\": \"\",\n \"baseCurve\": \"\",\n \"height\": \"\",\n \"nearMonocularPd\": \"\",\n \"farMonocularPd\": \"\",\n \"lotNumber\": \"\",\n \"invima\": \"\"\n },\n \"leftEye\": {\n \"id\": \"\",\n \"eye\": \"RIGHT\",\n \"lensType\": \"OCCUPATIONAL\",\n \"crystalType\": \"\",\n \"sphere\": \"\",\n \"cylinder\": \"\",\n \"axis\": \"\",\n \"addition\": \"\",\n \"near\": \"\",\n \"prism\": \"\",\n \"base\": \"\",\n \"diameter\": \"\",\n \"baseCurve\": \"\",\n \"height\": \"\",\n \"nearMonocularPd\": \"\",\n \"farMonocularPd\": \"\",\n \"lotNumber\": \"\",\n \"invima\": \"\"\n },\n \"rightEyeColorationProductId\": \"\",\n \"leftEyeColorationProductId\": \"\",\n \"rightEyeTreatmentProductId\": \"\",\n \"leftEyeTreatmentProductId\": \"\",\n \"rightEyeSupplementProductIds\": [\n \"\",\n \"\"\n ],\n \"leftEyeSupplementProductIds\": [\n \"\",\n \"\"\n ],\n \"rightEyeColoration\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"SUPPLEMENT\",\n \"sourceLineId\": \"\"\n },\n \"leftEyeColoration\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"SUPPLEMENT\",\n \"sourceLineId\": \"\"\n },\n \"rightEyeTreatment\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"TREATMENT\",\n \"sourceLineId\": \"\"\n },\n \"leftEyeTreatment\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"SUPPLEMENT\",\n \"sourceLineId\": \"\"\n },\n \"internalRef\": \"\",\n \"supplier\": \"\",\n \"notes\": \"\",\n \"notifyPatient\": \"\",\n \"ccode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "new", "description": "", "item": [ { "id": "14f82a60-cc16-407c-84d3-06e9cb7bdc74", "name": "Prototype optical order for a creation form", "request": { "name": "Prototype optical order for a creation form", "description": { "content": "Returns a non-persisted optical order prototype pre-filled with the authenticated user's default branch and the current date. The response carries no `id`, `version` or audit fields.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "optical-orders", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "64235de2-11d4-434b-94b6-c8cc9703ac4e", "name": "Optical order prototype with defaults", "originalRequest": { "url": { "path": [ "api", "v2", "optical-orders", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"documentType\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"documentStatusId\": \"\",\n \"documentStatusName\": \"\",\n \"assembled\": \"\",\n \"rawMaterialSelected\": \"\",\n \"bevelSent\": \"\",\n \"requestSupplier\": \"\",\n \"ownManufacturing\": \"\",\n \"ownFrame\": \"\",\n \"contactLenses\": \"\",\n \"sameLensBothEyes\": \"\",\n \"useRxForContactology\": \"\",\n \"documentDate\": \"\",\n \"firstPrintDate\": \"\",\n \"customerId\": \"\",\n \"customerName\": \"\",\n \"patientInitials\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"orderTypeId\": \"\",\n \"orderTypeName\": \"\",\n \"optometricExamId\": \"\",\n \"contactLensExamId\": \"\",\n \"customerOrderId\": \"\",\n \"invoiceId\": \"\",\n \"supplierOrderId\": \"\",\n \"productionOrderId\": \"\",\n \"frameShipmentTransferId\": \"\",\n \"bevelledLensTransferId\": \"\",\n \"finishedLensTransferId\": \"\",\n \"lastTraceId\": \"\",\n \"frameProductId\": \"\",\n \"frameProductName\": \"\",\n \"frameType\": \"AA\",\n \"frameHorizontal\": \"\",\n \"frameVertical\": \"\",\n \"frameBridge\": \"\",\n \"frameBiggestDiameter\": \"\",\n \"frameEffectiveDiameter\": \"\",\n \"frameMechanicalDistance\": \"\",\n \"pantoscopicAngle\": \"\",\n \"panoramicAngle\": \"\",\n \"vertexDistance\": \"\",\n \"nearWorkingDistance\": \"\",\n \"eyeRotationCenter\": \"\",\n \"pupillaryDistance\": \"\",\n \"medianDistance\": \"\",\n \"frameFit\": \"\",\n \"cCode\": \"\",\n \"heightRightEye\": \"\",\n \"heightLeftEye\": \"\",\n \"edgeThickness\": \"\",\n \"specialBase\": \"\",\n \"maxDecentrationRightEye\": \"\",\n \"maxDecentrationLeftEye\": \"\",\n \"dominantEye\": \"NONE\",\n \"nvb\": \"\",\n \"rightLensProductId\": \"\",\n \"rightLensProductName\": \"\",\n \"leftLensProductId\": \"\",\n \"leftLensProductName\": \"\",\n \"recommendedLensTypeRightEye\": \"OCCUPATIONAL\",\n \"recommendedLensTypeLeftEye\": \"BIFOCAL\",\n \"rawMaterialRightEyeProductId\": \"\",\n \"rawMaterialLeftEyeProductId\": \"\",\n \"rightEye\": {\n \"id\": \"\",\n \"eye\": \"RIGHT\",\n \"lensType\": \"PROGRESSIVE\",\n \"crystalType\": \"\",\n \"sphere\": \"\",\n \"cylinder\": \"\",\n \"axis\": \"\",\n \"addition\": \"\",\n \"near\": \"\",\n \"prism\": \"\",\n \"base\": \"\",\n \"diameter\": \"\",\n \"baseCurve\": \"\",\n \"height\": \"\",\n \"nearMonocularPd\": \"\",\n \"farMonocularPd\": \"\",\n \"lotNumber\": \"\",\n \"invima\": \"\"\n },\n \"leftEye\": {\n \"id\": \"\",\n \"eye\": \"RIGHT\",\n \"lensType\": \"INTERMEDIATE\",\n \"crystalType\": \"\",\n \"sphere\": \"\",\n \"cylinder\": \"\",\n \"axis\": \"\",\n \"addition\": \"\",\n \"near\": \"\",\n \"prism\": \"\",\n \"base\": \"\",\n \"diameter\": \"\",\n \"baseCurve\": \"\",\n \"height\": \"\",\n \"nearMonocularPd\": \"\",\n \"farMonocularPd\": \"\",\n \"lotNumber\": \"\",\n \"invima\": \"\"\n },\n \"rightEyeColoration\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"TREATMENT\",\n \"sourceLineId\": \"\"\n },\n \"leftEyeColoration\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"COLORATION\",\n \"sourceLineId\": \"\"\n },\n \"rightEyeTreatment\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"COLORATION\",\n \"sourceLineId\": \"\"\n },\n \"leftEyeTreatment\": {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"TREATMENT\",\n \"sourceLineId\": \"\"\n },\n \"rightEyeSupplements\": [\n {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"COLORATION\",\n \"sourceLineId\": \"\"\n },\n {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"TREATMENT\",\n \"sourceLineId\": \"\"\n }\n ],\n \"leftEyeSupplements\": [\n {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"SUPPLEMENT\",\n \"sourceLineId\": \"\"\n },\n {\n \"productId\": \"\",\n \"productName\": \"\",\n \"addOnType\": \"TREATMENT\",\n \"sourceLineId\": \"\"\n }\n ],\n \"internalRef\": \"\",\n \"supplier\": \"\",\n \"notes\": \"\",\n \"notificationsSent\": \"\",\n \"notifyPatient\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\",\n \"sourceSystem\": \"\",\n \"ccode\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a27ebd39-7a1d-4ee3-8c7f-538811a8a84b", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "optical-orders", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0dcfffc5-535c-40f5-895b-a2159cf7b732", "name": "Authenticated user is missing the `CREAR_ENCARGO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "optical-orders", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "27748473-b8f4-424f-a44f-f8f1ef41794a", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "optical-orders", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "notes", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "0eafe0fa-a446-4976-a2a6-7c20426c3033", "name": "Get note by ID", "request": { "name": "Get note by ID", "description": { "content": "Returns a single note by its primary key.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "7b76eb00-9dd9-453e-968a-b13526be7787", "name": "Note found", "originalRequest": { "url": { "path": [ "api", "v2", "notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"alert\": \"\",\n \"categoryKey\": \"\",\n \"categoryName\": \"\",\n \"categoryColor\": \"\",\n \"reminderAt\": \"\",\n \"ownerType\": \"customers\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6d48de96-4639-4ed4-9a72-9a970cab3013", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6e533d88-7a55-41e0-a152-b0f71ae8b15e", "name": "Authenticated user is missing read permission on customers or customer profiles", "originalRequest": { "url": { "path": [ "api", "v2", "notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "115e56be-9711-4e5f-ac58-3331656e4445", "name": "Note not found", "originalRequest": { "url": { "path": [ "api", "v2", "notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "51f8e471-77a0-4581-9ee2-ce884988ff57", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e83ff2fc-6651-475c-8a3a-4c58c30e1ccf", "name": "Update note", "request": { "name": "Update note", "description": { "content": "Full replacement of an existing note. Send the `If-Match` header for optimistic concurrency (accepted but ignored ÔÇö Nota is not versioned).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"alert\": \"\",\n \"categoryKey\": \"\",\n \"reminderAt\": \"\",\n \"ownerType\": \"customers\",\n \"ownerId\": \"\",\n \"employeeId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "7a8b89b5-eccf-4c0d-adc1-2c553336315f", "name": "Note updated", "originalRequest": { "url": { "path": [ "api", "v2", "notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"alert\": \"\",\n \"categoryKey\": \"\",\n \"reminderAt\": \"\",\n \"ownerType\": \"customers\",\n \"ownerId\": \"\",\n \"employeeId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"alert\": \"\",\n \"categoryKey\": \"\",\n \"categoryName\": \"\",\n \"categoryColor\": \"\",\n \"reminderAt\": \"\",\n \"ownerType\": \"customers\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c89b5096-5690-414c-9bb3-8beda57fbe7c", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"alert\": \"\",\n \"categoryKey\": \"\",\n \"reminderAt\": \"\",\n \"ownerType\": \"customers\",\n \"ownerId\": \"\",\n \"employeeId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b092eaee-9a78-429b-9732-c20dae580a0a", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"alert\": \"\",\n \"categoryKey\": \"\",\n \"reminderAt\": \"\",\n \"ownerType\": \"customers\",\n \"ownerId\": \"\",\n \"employeeId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "af947116-1a08-47eb-bc86-97af73da367d", "name": "Authenticated user is missing edit permission on customers or customer profiles", "originalRequest": { "url": { "path": [ "api", "v2", "notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"alert\": \"\",\n \"categoryKey\": \"\",\n \"reminderAt\": \"\",\n \"ownerType\": \"customers\",\n \"ownerId\": \"\",\n \"employeeId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a40fffbb-1bfc-4ee1-a5a2-f4972f0f1bfd", "name": "Note not found", "originalRequest": { "url": { "path": [ "api", "v2", "notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"alert\": \"\",\n \"categoryKey\": \"\",\n \"reminderAt\": \"\",\n \"ownerType\": \"customers\",\n \"ownerId\": \"\",\n \"employeeId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ce5aa1ed-21af-4fd0-90e4-8dca4382a534", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"alert\": \"\",\n \"categoryKey\": \"\",\n \"reminderAt\": \"\",\n \"ownerType\": \"customers\",\n \"ownerId\": \"\",\n \"employeeId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "88960b46-b88c-432a-a4a4-230cdd87cb45", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"alert\": \"\",\n \"categoryKey\": \"\",\n \"reminderAt\": \"\",\n \"ownerType\": \"customers\",\n \"ownerId\": \"\",\n \"employeeId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "76482592-f1c7-464f-9d85-f65f86b3efe2", "name": "Delete note", "request": { "name": "Delete note", "description": { "content": "Deletes a note. Send the `If-Match` header with the current ETag (accepted but ignored ÔÇö Nota is not versioned).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "0104d79e-d2b0-408a-a513-ad25b65843c8", "name": "Note deleted", "originalRequest": { "url": { "path": [ "api", "v2", "notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a94ead20-6267-49d3-943f-1c5e97871d37", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4ec55474-69de-484f-bd17-08e41fd4e535", "name": "Authenticated user is missing delete permission on customers or customer profiles", "originalRequest": { "url": { "path": [ "api", "v2", "notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b6ba2c72-1b94-4d18-95e6-9e0b1af8055b", "name": "Note not found", "originalRequest": { "url": { "path": [ "api", "v2", "notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "666df083-d79f-49e3-850b-acc3a5bb91b9", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c199f4c0-8b0c-434f-b988-600db2f23b1d", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a2da488d-5e57-4bca-900c-617bbf918e1a", "name": "Merge-patch note", "request": { "name": "Merge-patch note", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "03151406-93a7-4ab5-800e-4de6416b3b41", "name": "Note patched", "originalRequest": { "url": { "path": [ "api", "v2", "notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"alert\": \"\",\n \"categoryKey\": \"\",\n \"categoryName\": \"\",\n \"categoryColor\": \"\",\n \"reminderAt\": \"\",\n \"ownerType\": \"customers\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "987eddbb-7000-4147-8f05-8d4c12552359", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f6f7a0ad-d5fe-471f-91ae-f03102fea794", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "52bed843-4379-4d96-a67e-cef943bf443c", "name": "Authenticated user is missing edit permission on customers or customer profiles", "originalRequest": { "url": { "path": [ "api", "v2", "notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a2220742-40a4-4161-8052-f47941f832e9", "name": "Note not found", "originalRequest": { "url": { "path": [ "api", "v2", "notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bff1f78a-3ef8-41db-9851-6603a46b9fdd", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d1e9eb11-1623-429d-af79-2330ae8ab4e8", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Note ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "6fb679f1-e3f2-4b7a-bedc-aedf4c5059e6", "name": "List notes", "request": { "name": "List notes", "description": { "content": "Returns a paginated list of notes. Use RSQL filters `ownerType` and `ownerId` to scope notes to their owner entity. Default sort is `createdAt:desc`.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "createdAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "64c31a8a-08d9-4fb0-9402-f81d41aaeba0", "name": "Page of notes", "originalRequest": { "url": { "path": [ "api", "v2", "notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "createdAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7fe99fec-d3a2-4eea-be13-b442d9c8e53b", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "createdAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "eb46e17d-265c-45b9-a438-b5f75f4f8d05", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "createdAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "07b06343-dfec-41f5-b844-15740087b718", "name": "Authenticated user is missing read permission on customers or customer profiles", "originalRequest": { "url": { "path": [ "api", "v2", "notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "createdAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a9e2e6f7-a8e8-40d4-ae13-85869a3e00fb", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "createdAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fd22abb7-1e2d-4cac-99bc-f1186191c8b2", "name": "Create note", "request": { "name": "Create note", "description": { "content": "Creates a new note attached to a customer or customer profile. Set `ownerType` (`customers` | `customer-profiles`) and `ownerId` to bind the note.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"alert\": \"\",\n \"categoryKey\": \"\",\n \"reminderAt\": \"\",\n \"ownerType\": \"customers\",\n \"ownerId\": \"\",\n \"employeeId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "fe82396c-ae85-4ed0-93c9-cf6f444e4265", "name": "Note created", "originalRequest": { "url": { "path": [ "api", "v2", "notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"alert\": \"\",\n \"categoryKey\": \"\",\n \"reminderAt\": \"\",\n \"ownerType\": \"customers\",\n \"ownerId\": \"\",\n \"employeeId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"alert\": \"\",\n \"categoryKey\": \"\",\n \"categoryName\": \"\",\n \"categoryColor\": \"\",\n \"reminderAt\": \"\",\n \"ownerType\": \"customers\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b507f4a4-90f0-4b77-b126-2dc037daa4ab", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"alert\": \"\",\n \"categoryKey\": \"\",\n \"reminderAt\": \"\",\n \"ownerType\": \"customers\",\n \"ownerId\": \"\",\n \"employeeId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d7a925b9-b97e-4da5-b1de-0e36e3ad25e7", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"alert\": \"\",\n \"categoryKey\": \"\",\n \"reminderAt\": \"\",\n \"ownerType\": \"customers\",\n \"ownerId\": \"\",\n \"employeeId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "419cb255-b485-4755-8321-ab5ece954796", "name": "Authenticated user is missing edit permission on customers or customer profiles", "originalRequest": { "url": { "path": [ "api", "v2", "notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"alert\": \"\",\n \"categoryKey\": \"\",\n \"reminderAt\": \"\",\n \"ownerType\": \"customers\",\n \"ownerId\": \"\",\n \"employeeId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d1a7e7b0-c945-47d8-966d-1372efbd246a", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"alert\": \"\",\n \"categoryKey\": \"\",\n \"reminderAt\": \"\",\n \"ownerType\": \"customers\",\n \"ownerId\": \"\",\n \"employeeId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "me", "description": "", "item": [ { "name": "preferences", "description": "", "item": [ { "id": "e79f3bbf-c3e0-4c0a-904a-72b1bf9b6662", "name": "Get my preferences", "request": { "name": "Get my preferences", "description": { "content": "Returns the authenticated user's preferences. Always allowed when the JWT is valid.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "me", "preferences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "cdc969ac-336f-4981-8dd1-9c75b8f2dd77", "name": "Preferences", "originalRequest": { "url": { "path": [ "api", "v2", "me", "preferences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"userId\": \"\",\n \"username\": \"\",\n \"viewTemplates\": [\n {\n \"featureType\": \"\",\n \"viewId\": \"\"\n },\n {\n \"featureType\": \"\",\n \"viewId\": \"\"\n }\n ],\n \"screenTemplates\": [\n {\n \"screenKey\": \"\",\n \"templateId\": \"\"\n },\n {\n \"screenKey\": \"\",\n \"templateId\": \"\"\n }\n ],\n \"expandedListings\": [\n \"\",\n \"\"\n ],\n \"defaultDashboardId\": \"\",\n \"businessContext\": {\n \"companies\": [\n {\n \"id\": \"\",\n \"label\": \"\"\n },\n {\n \"id\": \"\",\n \"label\": \"\"\n }\n ],\n \"warehouses\": [\n {\n \"id\": \"\",\n \"label\": \"\"\n },\n {\n \"id\": \"\",\n \"label\": \"\"\n }\n ],\n \"currentCompanyId\": \"\",\n \"currentWarehouseId\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "510493fa-0d1f-4790-945e-90407a838231", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "me", "preferences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2d07818f-4aa4-438f-8056-234686b315e8", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "me", "preferences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "054f358e-c7bf-44d8-bce8-08d27579dea7", "name": "Update my preferences", "request": { "name": "Update my preferences", "description": { "content": "Updates the authenticated user's preferences. Null fields in the body are left untouched.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "me", "preferences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"viewTemplates\": [\n {\n \"featureType\": \"\",\n \"viewId\": \"\"\n },\n {\n \"featureType\": \"\",\n \"viewId\": \"\"\n }\n ],\n \"screenTemplates\": [\n {\n \"screenKey\": \"\",\n \"templateId\": \"\"\n },\n {\n \"screenKey\": \"\",\n \"templateId\": \"\"\n }\n ],\n \"expandedListings\": [\n \"\",\n \"\"\n ],\n \"defaultDashboardId\": \"\",\n \"businessContext\": {\n \"companies\": [\n {\n \"id\": \"\",\n \"label\": \"\"\n },\n {\n \"id\": \"\",\n \"label\": \"\"\n }\n ],\n \"warehouses\": [\n {\n \"id\": \"\",\n \"label\": \"\"\n },\n {\n \"id\": \"\",\n \"label\": \"\"\n }\n ],\n \"currentCompanyId\": \"\",\n \"currentWarehouseId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "f2ef1cf2-9d86-4dd0-b6fc-5870daf97ff3", "name": "Preferences", "originalRequest": { "url": { "path": [ "api", "v2", "me", "preferences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"viewTemplates\": [\n {\n \"featureType\": \"\",\n \"viewId\": \"\"\n },\n {\n \"featureType\": \"\",\n \"viewId\": \"\"\n }\n ],\n \"screenTemplates\": [\n {\n \"screenKey\": \"\",\n \"templateId\": \"\"\n },\n {\n \"screenKey\": \"\",\n \"templateId\": \"\"\n }\n ],\n \"expandedListings\": [\n \"\",\n \"\"\n ],\n \"defaultDashboardId\": \"\",\n \"businessContext\": {\n \"companies\": [\n {\n \"id\": \"\",\n \"label\": \"\"\n },\n {\n \"id\": \"\",\n \"label\": \"\"\n }\n ],\n \"warehouses\": [\n {\n \"id\": \"\",\n \"label\": \"\"\n },\n {\n \"id\": \"\",\n \"label\": \"\"\n }\n ],\n \"currentCompanyId\": \"\",\n \"currentWarehouseId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"userId\": \"\",\n \"username\": \"\",\n \"viewTemplates\": [\n {\n \"featureType\": \"\",\n \"viewId\": \"\"\n },\n {\n \"featureType\": \"\",\n \"viewId\": \"\"\n }\n ],\n \"screenTemplates\": [\n {\n \"screenKey\": \"\",\n \"templateId\": \"\"\n },\n {\n \"screenKey\": \"\",\n \"templateId\": \"\"\n }\n ],\n \"expandedListings\": [\n \"\",\n \"\"\n ],\n \"defaultDashboardId\": \"\",\n \"businessContext\": {\n \"companies\": [\n {\n \"id\": \"\",\n \"label\": \"\"\n },\n {\n \"id\": \"\",\n \"label\": \"\"\n }\n ],\n \"warehouses\": [\n {\n \"id\": \"\",\n \"label\": \"\"\n },\n {\n \"id\": \"\",\n \"label\": \"\"\n }\n ],\n \"currentCompanyId\": \"\",\n \"currentWarehouseId\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "981055b0-8db3-4659-a1fc-d6cd582e08ba", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "me", "preferences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"viewTemplates\": [\n {\n \"featureType\": \"\",\n \"viewId\": \"\"\n },\n {\n \"featureType\": \"\",\n \"viewId\": \"\"\n }\n ],\n \"screenTemplates\": [\n {\n \"screenKey\": \"\",\n \"templateId\": \"\"\n },\n {\n \"screenKey\": \"\",\n \"templateId\": \"\"\n }\n ],\n \"expandedListings\": [\n \"\",\n \"\"\n ],\n \"defaultDashboardId\": \"\",\n \"businessContext\": {\n \"companies\": [\n {\n \"id\": \"\",\n \"label\": \"\"\n },\n {\n \"id\": \"\",\n \"label\": \"\"\n }\n ],\n \"warehouses\": [\n {\n \"id\": \"\",\n \"label\": \"\"\n },\n {\n \"id\": \"\",\n \"label\": \"\"\n }\n ],\n \"currentCompanyId\": \"\",\n \"currentWarehouseId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "05fdaa82-6777-447a-8bcf-9196e3a6fed8", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "me", "preferences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"viewTemplates\": [\n {\n \"featureType\": \"\",\n \"viewId\": \"\"\n },\n {\n \"featureType\": \"\",\n \"viewId\": \"\"\n }\n ],\n \"screenTemplates\": [\n {\n \"screenKey\": \"\",\n \"templateId\": \"\"\n },\n {\n \"screenKey\": \"\",\n \"templateId\": \"\"\n }\n ],\n \"expandedListings\": [\n \"\",\n \"\"\n ],\n \"defaultDashboardId\": \"\",\n \"businessContext\": {\n \"companies\": [\n {\n \"id\": \"\",\n \"label\": \"\"\n },\n {\n \"id\": \"\",\n \"label\": \"\"\n }\n ],\n \"warehouses\": [\n {\n \"id\": \"\",\n \"label\": \"\"\n },\n {\n \"id\": \"\",\n \"label\": \"\"\n }\n ],\n \"currentCompanyId\": \"\",\n \"currentWarehouseId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "loyalty-wallets", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "0cd12cc8-feed-47b3-ae79-8ff25616643c", "name": "Get loyalty wallet by ID", "request": { "name": "Get loyalty wallet by ID", "description": { "content": "Returns a single loyalty wallet by its primary key, including members and the current points balance.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "loyalty-wallets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Loyalty wallet ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "514ac022-ba94-4b55-86dd-31f5b2063a8a", "name": "Loyalty wallet found", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Loyalty wallet ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"pointsBalance\": \"\",\n \"monetaryValue\": \"\",\n \"members\": [\n {\n \"customerAccountId\": \"\",\n \"customerAccountName\": \"\",\n \"customerOwner\": \"\"\n },\n {\n \"customerAccountId\": \"\",\n \"customerAccountName\": \"\",\n \"customerOwner\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d8bf56ac-cbae-4737-a102-aa747c1258c9", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Loyalty wallet ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "66723780-4558-46fd-a19e-5d162441133b", "name": "Authenticated user is missing the `VER_CARTERAPUNTOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Loyalty wallet ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8da5b955-1299-4e0c-8f10-80a821d36283", "name": "Loyalty wallet not found", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Loyalty wallet ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "01a43d71-a2fd-45f1-b821-9e69797e645e", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Loyalty wallet ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2dbe13db-5d8e-4de3-a98a-1213b4edb566", "name": "Update loyalty wallet", "request": { "name": "Update loyalty wallet", "description": { "content": "Full replacement of an existing loyalty wallet. `members`: null leaves existing membership untouched; [] clears; non-empty list replaces. `counterpartyAccountId` only selects the owner among the supplied members (ignored if not listed).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "loyalty-wallets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Loyalty wallet ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"pointOperations\": [\n {\n \"operation\": \"ADD\",\n \"points\": \"\",\n \"date\": \"\",\n \"type\": \"M\",\n \"concept\": \"\"\n },\n {\n \"operation\": \"ADD\",\n \"points\": \"\",\n \"date\": \"\",\n \"type\": \"W\",\n \"concept\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "7a2e2cc6-4dde-4778-ba05-45bae1e76812", "name": "Loyalty wallet updated", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Loyalty wallet ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"pointOperations\": [\n {\n \"operation\": \"ADD\",\n \"points\": \"\",\n \"date\": \"\",\n \"type\": \"M\",\n \"concept\": \"\"\n },\n {\n \"operation\": \"ADD\",\n \"points\": \"\",\n \"date\": \"\",\n \"type\": \"W\",\n \"concept\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"pointsBalance\": \"\",\n \"monetaryValue\": \"\",\n \"members\": [\n {\n \"customerAccountId\": \"\",\n \"customerAccountName\": \"\",\n \"customerOwner\": \"\"\n },\n {\n \"customerAccountId\": \"\",\n \"customerAccountName\": \"\",\n \"customerOwner\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cce7f9d1-5cb3-4cb9-a2a4-1c8022971ffe", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Loyalty wallet ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"pointOperations\": [\n {\n \"operation\": \"ADD\",\n \"points\": \"\",\n \"date\": \"\",\n \"type\": \"M\",\n \"concept\": \"\"\n },\n {\n \"operation\": \"ADD\",\n \"points\": \"\",\n \"date\": \"\",\n \"type\": \"W\",\n \"concept\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9a6427df-6f35-4419-9fca-4c467b7829c8", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Loyalty wallet ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"pointOperations\": [\n {\n \"operation\": \"ADD\",\n \"points\": \"\",\n \"date\": \"\",\n \"type\": \"M\",\n \"concept\": \"\"\n },\n {\n \"operation\": \"ADD\",\n \"points\": \"\",\n \"date\": \"\",\n \"type\": \"W\",\n \"concept\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5e047711-2cda-4f77-b976-c70e8f2445e6", "name": "Authenticated user is missing the `EDITAR_CARTERAPUNTOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Loyalty wallet ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"pointOperations\": [\n {\n \"operation\": \"ADD\",\n \"points\": \"\",\n \"date\": \"\",\n \"type\": \"M\",\n \"concept\": \"\"\n },\n {\n \"operation\": \"ADD\",\n \"points\": \"\",\n \"date\": \"\",\n \"type\": \"W\",\n \"concept\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3848888f-9d83-406f-98a2-5d37795297bc", "name": "Loyalty wallet not found", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Loyalty wallet ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"pointOperations\": [\n {\n \"operation\": \"ADD\",\n \"points\": \"\",\n \"date\": \"\",\n \"type\": \"M\",\n \"concept\": \"\"\n },\n {\n \"operation\": \"ADD\",\n \"points\": \"\",\n \"date\": \"\",\n \"type\": \"W\",\n \"concept\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e3bc022c-0157-45b7-a795-2bbd5f022d0f", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Loyalty wallet ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"pointOperations\": [\n {\n \"operation\": \"ADD\",\n \"points\": \"\",\n \"date\": \"\",\n \"type\": \"M\",\n \"concept\": \"\"\n },\n {\n \"operation\": \"ADD\",\n \"points\": \"\",\n \"date\": \"\",\n \"type\": \"W\",\n \"concept\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "08a0c03c-9fbf-4148-a87f-a8fb25ac2086", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Loyalty wallet ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"pointOperations\": [\n {\n \"operation\": \"ADD\",\n \"points\": \"\",\n \"date\": \"\",\n \"type\": \"M\",\n \"concept\": \"\"\n },\n {\n \"operation\": \"ADD\",\n \"points\": \"\",\n \"date\": \"\",\n \"type\": \"W\",\n \"concept\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a66178fd-942d-4cc9-86b0-3dd7a5a3cabd", "name": "Delete loyalty wallet", "request": { "name": "Delete loyalty wallet", "description": { "content": "Deletes a loyalty wallet.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "loyalty-wallets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Loyalty wallet ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "05cf99d9-2159-4866-a577-2cad129f5c80", "name": "Loyalty wallet deleted", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Loyalty wallet ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "46664333-f665-42f1-a912-e8de1218fa1b", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Loyalty wallet ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "28cd1683-7300-46f0-8b41-1ad784eeabb2", "name": "Authenticated user is missing the `BORRAR_CARTERAPUNTOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Loyalty wallet ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "26246c1b-f1bc-4ca2-9dba-4c078e140676", "name": "Loyalty wallet not found", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Loyalty wallet ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0140f6c4-7eb2-48c0-8c59-3c5814f4cdf7", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Loyalty wallet ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "077ecc5b-fca0-4b72-b6e8-d4bb88ebc6f5", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Loyalty wallet ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3eaec006-7143-470e-91c8-18bb596b01c0", "name": "Merge-patch loyalty wallet", "request": { "name": "Merge-patch loyalty wallet", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "loyalty-wallets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Loyalty wallet ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "84369dd8-7922-46ea-a52f-3aee8d26be11", "name": "Loyalty wallet patched", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Loyalty wallet ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"pointsBalance\": \"\",\n \"monetaryValue\": \"\",\n \"members\": [\n {\n \"customerAccountId\": \"\",\n \"customerAccountName\": \"\",\n \"customerOwner\": \"\"\n },\n {\n \"customerAccountId\": \"\",\n \"customerAccountName\": \"\",\n \"customerOwner\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3b3f975f-7d96-486b-8aa9-6aa3f2406e3c", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Loyalty wallet ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5f1ef436-495c-498e-a483-52e39316d461", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Loyalty wallet ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "65c1834f-99ba-43ff-bfd8-b489647afd6d", "name": "Authenticated user is missing the `EDITAR_CARTERAPUNTOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Loyalty wallet ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "787b472d-d827-4708-94ad-f2f150f628b6", "name": "Loyalty wallet not found", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Loyalty wallet ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "28592c60-f164-4376-bf5a-e78767fecdb4", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Loyalty wallet ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "29983275-2153-43de-9ad3-d89eac4d4786", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Loyalty wallet ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "change-points", "description": "", "item": [ { "id": "d19ddc81-ab1f-40b3-b6da-8e441609addb", "name": "Change loyalty wallet balance", "request": { "name": "Change loyalty wallet balance", "description": { "content": "Adds or removes points from the wallet via a manual ledger movement. REMOVE operations additionally require the `REMOVE_PUNTOS_MANUAL` permission on the legacy WAR side.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "loyalty-wallets", ":id", "change-points" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Loyalty wallet ID", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"operation\": \"ADD\",\n \"points\": \"\",\n \"date\": \"\",\n \"type\": \"W\",\n \"concept\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "eefad443-c4eb-4b26-a53b-d74e164d81a4", "name": "Loyalty wallet updated with new balance", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets", ":id", "change-points" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Loyalty wallet ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"operation\": \"ADD\",\n \"points\": \"\",\n \"date\": \"\",\n \"type\": \"W\",\n \"concept\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"pointsBalance\": \"\",\n \"monetaryValue\": \"\",\n \"members\": [\n {\n \"customerAccountId\": \"\",\n \"customerAccountName\": \"\",\n \"customerOwner\": \"\"\n },\n {\n \"customerAccountId\": \"\",\n \"customerAccountName\": \"\",\n \"customerOwner\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8eb2825f-69e3-4843-bb60-e99d331f90c3", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets", ":id", "change-points" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Loyalty wallet ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"operation\": \"ADD\",\n \"points\": \"\",\n \"date\": \"\",\n \"type\": \"W\",\n \"concept\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "840931ff-bd2d-4632-9352-4b34f6824c4b", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets", ":id", "change-points" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Loyalty wallet ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"operation\": \"ADD\",\n \"points\": \"\",\n \"date\": \"\",\n \"type\": \"W\",\n \"concept\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9a109ebf-cc88-46fc-9006-8c96d6557ff4", "name": "Authenticated user is missing the `EDITAR_CARTERAPUNTOS` permission or `REMOVE_PUNTOS_MANUAL` for REMOVE operations", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets", ":id", "change-points" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Loyalty wallet ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"operation\": \"ADD\",\n \"points\": \"\",\n \"date\": \"\",\n \"type\": \"W\",\n \"concept\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2dc2e012-55e6-4c1e-95c8-5f032e48ca5a", "name": "Loyalty wallet not found", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets", ":id", "change-points" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Loyalty wallet ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"operation\": \"ADD\",\n \"points\": \"\",\n \"date\": \"\",\n \"type\": \"W\",\n \"concept\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "088c49e7-0bb7-4f99-8bef-1f819d3e6c4d", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets", ":id", "change-points" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Loyalty wallet ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"operation\": \"ADD\",\n \"points\": \"\",\n \"date\": \"\",\n \"type\": \"W\",\n \"concept\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "change-members", "description": "", "item": [ { "id": "15413382-a158-4f4d-ae6b-6bf210d40101", "name": "Change loyalty wallet members", "request": { "name": "Change loyalty wallet members", "description": { "content": "Adds or removes a customer from the shared wallet without replacing the full `members` collection. Use `customerOwner=true` on ADD to set the owner.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "loyalty-wallets", ":id", "change-members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Loyalty wallet ID", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customerId\": \"\",\n \"customerOwner\": \"\",\n \"operation\": \"REMOVE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "a615a6bc-4424-4c1b-b594-13823cef1a74", "name": "Loyalty wallet updated with new membership", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets", ":id", "change-members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Loyalty wallet ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customerId\": \"\",\n \"customerOwner\": \"\",\n \"operation\": \"REMOVE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"pointsBalance\": \"\",\n \"monetaryValue\": \"\",\n \"members\": [\n {\n \"customerAccountId\": \"\",\n \"customerAccountName\": \"\",\n \"customerOwner\": \"\"\n },\n {\n \"customerAccountId\": \"\",\n \"customerAccountName\": \"\",\n \"customerOwner\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f0075a85-19f5-45cb-b526-39debb13dc47", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets", ":id", "change-members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Loyalty wallet ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customerId\": \"\",\n \"customerOwner\": \"\",\n \"operation\": \"REMOVE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "279440aa-4c8e-4a4a-b00c-5bd4b4b42770", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets", ":id", "change-members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Loyalty wallet ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customerId\": \"\",\n \"customerOwner\": \"\",\n \"operation\": \"REMOVE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a055a87a-1cc7-461e-b93b-f15f8b6cb524", "name": "Authenticated user is missing the `EDITAR_CARTERAPUNTOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets", ":id", "change-members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Loyalty wallet ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customerId\": \"\",\n \"customerOwner\": \"\",\n \"operation\": \"REMOVE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fdf15e65-05e0-4085-adba-50ce06a3acfb", "name": "Loyalty wallet not found", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets", ":id", "change-members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Loyalty wallet ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customerId\": \"\",\n \"customerOwner\": \"\",\n \"operation\": \"REMOVE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7cbf72bc-11e2-4e65-b158-70c0c0e209c5", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets", ":id", "change-members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Loyalty wallet ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customerId\": \"\",\n \"customerOwner\": \"\",\n \"operation\": \"REMOVE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "transactions", "description": "", "item": [ { "id": "e08533da-f465-48d4-a103-afe17f7d080f", "name": "List loyalty wallet transactions", "request": { "name": "List loyalty wallet transactions", "description": { "content": "Returns a paginated ledger of points movements for the given wallet. Supports the same RSQL `filter`, `sort`, `skip`/`limit` and `modifiedAfter`/`modifiedBefore` parameters as the main listing.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "loyalty-wallets", ":id", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "date:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Loyalty wallet ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "9c22f56b-824d-454f-ba74-591b146ea2b8", "name": "Page of points transactions", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets", ":id", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "date:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Loyalty wallet ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6c61bd39-3fd5-42a4-bea4-c5906ade9778", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets", ":id", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "date:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Loyalty wallet ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d48f6612-4e55-47f7-ae80-58177664fdf3", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets", ":id", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "date:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Loyalty wallet ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "17a82df7-0d92-4d49-af75-b98f141e9771", "name": "Authenticated user is missing the `VER_CARTERAPUNTOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets", ":id", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "date:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Loyalty wallet ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6565402e-8500-4b01-bb0d-9f90ed5752b2", "name": "Loyalty wallet not found", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets", ":id", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "date:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Loyalty wallet ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fae73dd1-0db1-4700-8d62-8de888cb702a", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets", ":id", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "date:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Loyalty wallet ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "id": "ddfab67e-17a0-4a09-98a3-9897446c5752", "name": "List loyalty wallets", "request": { "name": "List loyalty wallets", "description": { "content": "Returns a paginated list of loyalty wallets with envelope `{data, totalCount, skip, limit, hasMore}`. Supports optional RSQL `filter`, `sort` (default `lastModifiedAt:desc`), `skip`/`limit` pagination and `modifiedAfter`/`modifiedBefore` bookends.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "loyalty-wallets" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "bd01df10-626b-4d06-a69f-52e33b6a0679", "name": "Page of loyalty wallets", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "23382b9a-8492-4084-b0d0-7eff98b1de8b", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a84f0dec-7220-4efc-99e5-7bafed512ed3", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e0ac3474-e379-4d74-81ff-82da57c61251", "name": "Authenticated user is missing the `VER_CARTERAPUNTOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9f7e7334-7a2c-40c3-bc92-508f45994ba0", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4fff5163-df3a-4dc6-90ab-292f0e25fb35", "name": "Create loyalty wallet", "request": { "name": "Create loyalty wallet", "description": { "content": "Creates a new loyalty wallet. Business logic runs in the legacy WAR. `code` is optional: when omitted the WAR assigns the next sequential company-scoped code (same rule as `POST /loyalty-wallets/new`). Optional `members` links customers on creation (`null` leaves empty; `[]` clears; list replaces). `counterpartyAccountId` sets the owner when `members` is omitted. Optional `pointsBalance` seeds an initial manual movement.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "loyalty-wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"pointOperations\": [\n {\n \"operation\": \"ADD\",\n \"points\": \"\",\n \"date\": \"\",\n \"type\": \"M\",\n \"concept\": \"\"\n },\n {\n \"operation\": \"ADD\",\n \"points\": \"\",\n \"date\": \"\",\n \"type\": \"W\",\n \"concept\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "c024278a-d76e-4a70-839a-a88aff658e23", "name": "Loyalty wallet created", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"pointOperations\": [\n {\n \"operation\": \"ADD\",\n \"points\": \"\",\n \"date\": \"\",\n \"type\": \"M\",\n \"concept\": \"\"\n },\n {\n \"operation\": \"ADD\",\n \"points\": \"\",\n \"date\": \"\",\n \"type\": \"W\",\n \"concept\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"pointsBalance\": \"\",\n \"monetaryValue\": \"\",\n \"members\": [\n {\n \"customerAccountId\": \"\",\n \"customerAccountName\": \"\",\n \"customerOwner\": \"\"\n },\n {\n \"customerAccountId\": \"\",\n \"customerAccountName\": \"\",\n \"customerOwner\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a5a62276-a0d9-4109-b693-e63ba7a5f397", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"pointOperations\": [\n {\n \"operation\": \"ADD\",\n \"points\": \"\",\n \"date\": \"\",\n \"type\": \"M\",\n \"concept\": \"\"\n },\n {\n \"operation\": \"ADD\",\n \"points\": \"\",\n \"date\": \"\",\n \"type\": \"W\",\n \"concept\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "55864492-cae2-41e0-b8bd-7a58e85c3c7d", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"pointOperations\": [\n {\n \"operation\": \"ADD\",\n \"points\": \"\",\n \"date\": \"\",\n \"type\": \"M\",\n \"concept\": \"\"\n },\n {\n \"operation\": \"ADD\",\n \"points\": \"\",\n \"date\": \"\",\n \"type\": \"W\",\n \"concept\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1866c07d-233f-4d5a-92f8-a79f9c091562", "name": "Authenticated user is missing the `CREAR_CARTERAPUNTOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"pointOperations\": [\n {\n \"operation\": \"ADD\",\n \"points\": \"\",\n \"date\": \"\",\n \"type\": \"M\",\n \"concept\": \"\"\n },\n {\n \"operation\": \"ADD\",\n \"points\": \"\",\n \"date\": \"\",\n \"type\": \"W\",\n \"concept\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ad20a636-4162-40b1-a935-5403ecf9353c", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"pointOperations\": [\n {\n \"operation\": \"ADD\",\n \"points\": \"\",\n \"date\": \"\",\n \"type\": \"M\",\n \"concept\": \"\"\n },\n {\n \"operation\": \"ADD\",\n \"points\": \"\",\n \"date\": \"\",\n \"type\": \"W\",\n \"concept\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c3b06804-c62e-4202-91bd-95d101255769", "name": "Bulk delete loyalty wallets", "request": { "name": "Bulk delete loyalty wallets", "description": { "content": "Removes every id in `ids` as a single all-or-nothing transaction.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "loyalty-wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "7b5a7987-c448-4316-9495-c93b0304b38a", "name": "All entities deleted", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"deleted\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "adb19d85-a03e-4941-9858-8d95c92f7be2", "name": "Empty `ids` or unknown id", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "76c3e0de-0a84-416b-a44b-9513b56d02e4", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "54728328-df04-4c90-85be-730431d1f4e5", "name": "Authenticated user is missing the `BORRAR_CARTERAPUNTOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5e5a2cc4-ab70-4bd2-bf79-6006f6491799", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "08c821cb-4b90-4380-9ff1-c430c565a4e9", "name": "Bulk patch loyalty wallets", "request": { "name": "Bulk patch loyalty wallets", "description": { "content": "Applies the same `patch` to every id in `ids` as a single all-or-nothing transaction. Editable fields: `enabled`, `description`.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "loyalty-wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"patch\": {\n \"key_0\": \"string\",\n \"key_1\": 4074,\n \"key_2\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "408cbe28-415e-4789-8214-04016984d2fd", "name": "All entities updated", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"patch\": {\n \"key_0\": \"string\",\n \"key_1\": 4074,\n \"key_2\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"updated\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "62aa86cd-3a46-4a1b-8d06-fd27847cb40a", "name": "Empty `ids`/`patch`, malformed payload or non-whitelisted field", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"patch\": {\n \"key_0\": \"string\",\n \"key_1\": 4074,\n \"key_2\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2ab8bfd2-9086-44b3-b521-7e0dba04c073", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"patch\": {\n \"key_0\": \"string\",\n \"key_1\": 4074,\n \"key_2\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7e137c5c-4a09-42d5-8953-8b4b88dbf43d", "name": "Authenticated user is missing the `EDITAR_CARTERAPUNTOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"patch\": {\n \"key_0\": \"string\",\n \"key_1\": 4074,\n \"key_2\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1549a41f-e3d1-4877-9ef5-c591fe7ec24d", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"patch\": {\n \"key_0\": \"string\",\n \"key_1\": 4074,\n \"key_2\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "new", "description": "", "item": [ { "id": "cab4738f-c756-4f20-96f6-fac50f56854f", "name": "Prototype loyalty wallet for a creation form", "request": { "name": "Prototype loyalty wallet for a creation form", "description": { "content": "Returns a non-persisted loyalty wallet pre-populated with backend defaults (current company, next sequential `code`, `enabled=true`). Optional JSON hints: `companyId`. Call `POST /api/v2/loyalty-wallets` to persist.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "loyalty-wallets", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "320f3690-28db-4e6f-a98c-1e19376b23b0", "name": "Loyalty wallet prototype with defaults", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"pointsBalance\": \"\",\n \"monetaryValue\": \"\",\n \"members\": [\n {\n \"customerAccountId\": \"\",\n \"customerAccountName\": \"\",\n \"customerOwner\": \"\"\n },\n {\n \"customerAccountId\": \"\",\n \"customerAccountName\": \"\",\n \"customerOwner\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "804b5dff-1d2e-4960-a252-91eac9e5b300", "name": "Invalid prepare-create hints", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "845e6bdb-f691-47b2-9f4a-c9258c6bfd50", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "09f704d7-ae3e-4d7f-8bec-d86af1817cb7", "name": "Authenticated user is missing the `CREAR_CARTERAPUNTOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c83b2706-b85c-47b3-a3c5-4139b4fbfe52", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "loyalty-wallets", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "label-formats", "description": "", "item": [ { "name": "{code}", "description": "", "item": [ { "name": "favorite", "description": "", "item": [ { "id": "0dc4e26d-ba02-4ffe-9780-db477bd4bb14", "name": "Set label format favourite", "request": { "name": "Set label format favourite", "description": { "content": "Marks or unmarks the label format as a favourite for the current user.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "label-formats", ":code", "favorite" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "code", "disabled": false, "description": { "content": "(Required) Label format code", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"favorite\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "bf5edbb7-dc43-4d76-999d-da1648277425", "name": "Updated label format", "originalRequest": { "url": { "path": [ "api", "v2", "label-formats", ":code", "favorite" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Label format code", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"favorite\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"code\": \"\",\n \"name\": \"\",\n \"shape\": \"RECTANGULAR\",\n \"material\": \"PUNCHED\",\n \"medium\": \"ZEBRA_ZPL\",\n \"widthMm\": \"\",\n \"heightMm\": \"\",\n \"labelsPerSheet\": \"\",\n \"thumbnailUrl\": \"\",\n \"supportsBarcode\": \"\",\n \"supportsFreeField\": \"\",\n \"favorite\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "45aa2e98-e692-44ce-b5e8-3f5aea94438f", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "label-formats", ":code", "favorite" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Label format code", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"favorite\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "40887db3-3609-4902-85ce-72f86c755824", "name": "Authenticated user is missing the `CREAR_ETIQUETAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "label-formats", ":code", "favorite" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Label format code", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"favorite\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "58e99d36-b868-4093-9dac-da76018448d9", "name": "Label format not found", "originalRequest": { "url": { "path": [ "api", "v2", "label-formats", ":code", "favorite" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Label format code", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"favorite\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "36d8364f-f901-4473-bc53-cd1b3555151c", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "label-formats", ":code", "favorite" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Label format code", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"favorite\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "cbfcbb3b-312f-4f84-8c2d-9be89452a544", "name": "Get label format by code", "request": { "name": "Get label format by code", "description": { "content": "Returns a single label format by its stable code.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "label-formats", ":code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "code", "disabled": false, "description": { "content": "(Required) Label format code", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "f02973a9-7951-4cab-ab73-c0241a5cf9a7", "name": "Label format found", "originalRequest": { "url": { "path": [ "api", "v2", "label-formats", ":code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Label format code", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"code\": \"\",\n \"name\": \"\",\n \"shape\": \"RECTANGULAR\",\n \"material\": \"PUNCHED\",\n \"medium\": \"ZEBRA_ZPL\",\n \"widthMm\": \"\",\n \"heightMm\": \"\",\n \"labelsPerSheet\": \"\",\n \"thumbnailUrl\": \"\",\n \"supportsBarcode\": \"\",\n \"supportsFreeField\": \"\",\n \"favorite\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8b8f07d2-da80-4016-9bf3-29ca002fcdaf", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "label-formats", ":code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Label format code", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ac992c28-ca56-417e-aa22-dec2b8621c23", "name": "Authenticated user is missing the `CREAR_ETIQUETAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "label-formats", ":code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Label format code", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2d9d6f8f-f2e9-4cee-a79f-2aad73c9798a", "name": "Label format not found", "originalRequest": { "url": { "path": [ "api", "v2", "label-formats", ":code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Label format code", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "caba9c1a-39d0-4615-b39f-55a93798ceae", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "label-formats", ":code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Label format code", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "thumbnail", "description": "", "item": [ { "id": "b679bf02-8dca-44b7-a7ee-7b0ae21ba1ff", "name": "Get label format thumbnail", "request": { "name": "Get label format thumbnail", "description": { "content": "Returns the PNG thumbnail preview of the label format.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "label-formats", ":code", "thumbnail" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "code", "disabled": false, "description": { "content": "(Required) Label format code", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "image/png" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "c76bded2-0fef-4c8f-84be-a4dc7154c86f", "name": "Thumbnail image (PNG)", "originalRequest": { "url": { "path": [ "api", "v2", "label-formats", ":code", "thumbnail" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Label format code", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "key": "Accept", "value": "image/png" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "image/png" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "dbfbb96f-9a6c-4c0b-bfc9-404919632e84", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "label-formats", ":code", "thumbnail" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Label format code", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "key": "Accept", "value": "image/png" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "image/png" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4f615482-1979-41d4-a6a3-4a0c5ac11121", "name": "Authenticated user is missing the `CREAR_ETIQUETAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "label-formats", ":code", "thumbnail" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Label format code", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "key": "Accept", "value": "image/png" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "image/png" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8d89be10-df9d-402f-8188-401ac450d23f", "name": "Label format or thumbnail not found", "originalRequest": { "url": { "path": [ "api", "v2", "label-formats", ":code", "thumbnail" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Label format code", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "key": "Accept", "value": "image/png" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "image/png" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "317fc82b-4f2b-4649-820e-acae1b754147", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "label-formats", ":code", "thumbnail" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Label format code", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "key": "Accept", "value": "image/png" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "image/png" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "id": "4ff78ef8-c834-45cc-9816-5347425bb804", "name": "List label formats", "request": { "name": "List label formats", "description": { "content": "Returns the catalog of product-label formats with envelope `{data, totalCount, skip, limit, hasMore}`. Optional filters: `material` (PUNCHED/CONTINUOUS), `medium` (PDF/ZEBRA_ZPL) and `favorite`. Sorted by name.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "label-formats" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by physical media", "type": "text/plain" }, "key": "material", "value": "" }, { "disabled": false, "description": { "content": "Filter by output medium", "type": "text/plain" }, "key": "medium", "value": "" }, { "disabled": false, "description": { "content": "Filter by the current user's favourite flag", "type": "text/plain" }, "key": "favorite", "value": "" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "cd582e90-1903-43b5-a92b-9d8869a3d6ce", "name": "Page of label formats", "originalRequest": { "url": { "path": [ "api", "v2", "label-formats" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by physical media", "type": "text/plain" }, "key": "material", "value": "" }, { "disabled": false, "description": { "content": "Filter by output medium", "type": "text/plain" }, "key": "medium", "value": "" }, { "disabled": false, "description": { "content": "Filter by the current user's favourite flag", "type": "text/plain" }, "key": "favorite", "value": "" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "eeba63e4-c975-41e4-ac94-ad41969de21a", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "label-formats" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by physical media", "type": "text/plain" }, "key": "material", "value": "" }, { "disabled": false, "description": { "content": "Filter by output medium", "type": "text/plain" }, "key": "medium", "value": "" }, { "disabled": false, "description": { "content": "Filter by the current user's favourite flag", "type": "text/plain" }, "key": "favorite", "value": "" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "92a7e478-e1f7-4278-9bc3-7e263af0b75b", "name": "Authenticated user is missing the `CREAR_ETIQUETAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "label-formats" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by physical media", "type": "text/plain" }, "key": "material", "value": "" }, { "disabled": false, "description": { "content": "Filter by output medium", "type": "text/plain" }, "key": "medium", "value": "" }, { "disabled": false, "description": { "content": "Filter by the current user's favourite flag", "type": "text/plain" }, "key": "favorite", "value": "" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c1cd4c99-1023-4665-a295-c374d2cf9bc5", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "label-formats" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by physical media", "type": "text/plain" }, "key": "material", "value": "" }, { "disabled": false, "description": { "content": "Filter by output medium", "type": "text/plain" }, "key": "medium", "value": "" }, { "disabled": false, "description": { "content": "Filter by the current user's favourite flag", "type": "text/plain" }, "key": "favorite", "value": "" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "journal-entries", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "6d24c59d-0110-4f02-a058-4e35919055c9", "name": "Get journal entry by ID", "request": { "name": "Get journal entry by ID", "description": { "content": "Returns a single journal entry including its lines.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "journal-entries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Journal entry ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "b846cc32-ca92-4bec-9bd9-e5f47f87372a", "name": "Journal entry found", "originalRequest": { "url": { "path": [ "api", "v2", "journal-entries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Journal entry ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"series\": \"\",\n \"entryNumber\": \"\",\n \"accountingDate\": \"\",\n \"fiscalYear\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"activityId\": \"\",\n \"activityName\": \"\",\n \"accountingBook\": \"\",\n \"entryType\": \"REG\",\n \"predefinedDocument\": \"\",\n \"lockType\": \"\",\n \"modified\": \"\",\n \"balanced\": \"\",\n \"totalDebit\": \"\",\n \"totalCredit\": \"\",\n \"balanceDifference\": \"\",\n \"invoiceId\": \"\",\n \"paymentId\": \"\",\n \"payrollId\": \"\",\n \"cashRegisterId\": \"\",\n \"lines\": [\n {\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"viewLineNumber\": \"\",\n \"debit\": \"\",\n \"accountingAccountId\": \"\",\n \"accountingAccountName\": \"\",\n \"offsetAccountId\": \"\",\n \"offsetAccountName\": \"\",\n \"activityId\": \"\",\n \"activityName\": \"\",\n \"amount\": \"\",\n \"concept\": \"\",\n \"extension\": \"\",\n \"invoiceLineId\": \"\",\n \"costCenterAllocations\": [\n {\n \"id\": \"\",\n \"costCenterId\": \"\",\n \"costCenterName\": \"\",\n \"subCostCenterId\": \"\",\n \"subCostCenterName\": \"\",\n \"amount\": \"\"\n },\n {\n \"id\": \"\",\n \"costCenterId\": \"\",\n \"costCenterName\": \"\",\n \"subCostCenterId\": \"\",\n \"subCostCenterName\": \"\",\n \"amount\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"viewLineNumber\": \"\",\n \"debit\": \"\",\n \"accountingAccountId\": \"\",\n \"accountingAccountName\": \"\",\n \"offsetAccountId\": \"\",\n \"offsetAccountName\": \"\",\n \"activityId\": \"\",\n \"activityName\": \"\",\n \"amount\": \"\",\n \"concept\": \"\",\n \"extension\": \"\",\n \"invoiceLineId\": \"\",\n \"costCenterAllocations\": [\n {\n \"id\": \"\",\n \"costCenterId\": \"\",\n \"costCenterName\": \"\",\n \"subCostCenterId\": \"\",\n \"subCostCenterName\": \"\",\n \"amount\": \"\"\n },\n {\n \"id\": \"\",\n \"costCenterId\": \"\",\n \"costCenterName\": \"\",\n \"subCostCenterId\": \"\",\n \"subCostCenterName\": \"\",\n \"amount\": \"\"\n }\n ]\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "70c0f66c-e3e9-4f3b-bc96-1f40a66abd19", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "journal-entries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Journal entry ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "62ab3c3f-d80b-4045-82dc-20267b5dbe9a", "name": "Authenticated user is missing the `VER_ASIENTOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "journal-entries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Journal entry ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "dbfb77f9-93a1-49f1-9608-4e10ba0a6f19", "name": "Journal entry not found", "originalRequest": { "url": { "path": [ "api", "v2", "journal-entries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Journal entry ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c9016a39-af57-4235-b842-fef2bb5c6e02", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "journal-entries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Journal entry ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d61bae65-0109-4db3-9123-64a932b6dce3", "name": "Update journal entry", "request": { "name": "Update journal entry", "description": { "content": "Full replacement of an existing journal entry.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "journal-entries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Journal entry ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"accountingDate\": \"\",\n \"fiscalYear\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"companyId\": \"\",\n \"activityId\": \"\",\n \"accountingBook\": \"\",\n \"entryType\": \"COBRO\",\n \"lines\": [\n {\n \"lineNumber\": \"\",\n \"debit\": \"\",\n \"accountingAccountId\": \"\",\n \"offsetAccountId\": \"\",\n \"activityId\": \"\",\n \"amount\": \"\",\n \"concept\": \"\",\n \"extension\": \"\",\n \"costCenterAllocations\": [\n {\n \"costCenterId\": \"\",\n \"subCostCenterId\": \"\",\n \"amount\": \"\"\n },\n {\n \"costCenterId\": \"\",\n \"subCostCenterId\": \"\",\n \"amount\": \"\"\n }\n ]\n },\n {\n \"lineNumber\": \"\",\n \"debit\": \"\",\n \"accountingAccountId\": \"\",\n \"offsetAccountId\": \"\",\n \"activityId\": \"\",\n \"amount\": \"\",\n \"concept\": \"\",\n \"extension\": \"\",\n \"costCenterAllocations\": [\n {\n \"costCenterId\": \"\",\n \"subCostCenterId\": \"\",\n \"amount\": \"\"\n },\n {\n \"costCenterId\": \"\",\n \"subCostCenterId\": \"\",\n \"amount\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "7c6ea3ed-0593-45be-8be4-6ebad3d655cf", "name": "Journal entry updated", "originalRequest": { "url": { "path": [ "api", "v2", "journal-entries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Journal entry ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"accountingDate\": \"\",\n \"fiscalYear\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"companyId\": \"\",\n \"activityId\": \"\",\n \"accountingBook\": \"\",\n \"entryType\": \"COBRO\",\n \"lines\": [\n {\n \"lineNumber\": \"\",\n \"debit\": \"\",\n \"accountingAccountId\": \"\",\n \"offsetAccountId\": \"\",\n \"activityId\": \"\",\n \"amount\": \"\",\n \"concept\": \"\",\n \"extension\": \"\",\n \"costCenterAllocations\": [\n {\n \"costCenterId\": \"\",\n \"subCostCenterId\": \"\",\n \"amount\": \"\"\n },\n {\n \"costCenterId\": \"\",\n \"subCostCenterId\": \"\",\n \"amount\": \"\"\n }\n ]\n },\n {\n \"lineNumber\": \"\",\n \"debit\": \"\",\n \"accountingAccountId\": \"\",\n \"offsetAccountId\": \"\",\n \"activityId\": \"\",\n \"amount\": \"\",\n \"concept\": \"\",\n \"extension\": \"\",\n \"costCenterAllocations\": [\n {\n \"costCenterId\": \"\",\n \"subCostCenterId\": \"\",\n \"amount\": \"\"\n },\n {\n \"costCenterId\": \"\",\n \"subCostCenterId\": \"\",\n \"amount\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"series\": \"\",\n \"entryNumber\": \"\",\n \"accountingDate\": \"\",\n \"fiscalYear\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"activityId\": \"\",\n \"activityName\": \"\",\n \"accountingBook\": \"\",\n \"entryType\": \"REG\",\n \"predefinedDocument\": \"\",\n \"lockType\": \"\",\n \"modified\": \"\",\n \"balanced\": \"\",\n \"totalDebit\": \"\",\n \"totalCredit\": \"\",\n \"balanceDifference\": \"\",\n \"invoiceId\": \"\",\n \"paymentId\": \"\",\n \"payrollId\": \"\",\n \"cashRegisterId\": \"\",\n \"lines\": [\n {\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"viewLineNumber\": \"\",\n \"debit\": \"\",\n \"accountingAccountId\": \"\",\n \"accountingAccountName\": \"\",\n \"offsetAccountId\": \"\",\n \"offsetAccountName\": \"\",\n \"activityId\": \"\",\n \"activityName\": \"\",\n \"amount\": \"\",\n \"concept\": \"\",\n \"extension\": \"\",\n \"invoiceLineId\": \"\",\n \"costCenterAllocations\": [\n {\n \"id\": \"\",\n \"costCenterId\": \"\",\n \"costCenterName\": \"\",\n \"subCostCenterId\": \"\",\n \"subCostCenterName\": \"\",\n \"amount\": \"\"\n },\n {\n \"id\": \"\",\n \"costCenterId\": \"\",\n \"costCenterName\": \"\",\n \"subCostCenterId\": \"\",\n \"subCostCenterName\": \"\",\n \"amount\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"viewLineNumber\": \"\",\n \"debit\": \"\",\n \"accountingAccountId\": \"\",\n \"accountingAccountName\": \"\",\n \"offsetAccountId\": \"\",\n \"offsetAccountName\": \"\",\n \"activityId\": \"\",\n \"activityName\": \"\",\n \"amount\": \"\",\n \"concept\": \"\",\n \"extension\": \"\",\n \"invoiceLineId\": \"\",\n \"costCenterAllocations\": [\n {\n \"id\": \"\",\n \"costCenterId\": \"\",\n \"costCenterName\": \"\",\n \"subCostCenterId\": \"\",\n \"subCostCenterName\": \"\",\n \"amount\": \"\"\n },\n {\n \"id\": \"\",\n \"costCenterId\": \"\",\n \"costCenterName\": \"\",\n \"subCostCenterId\": \"\",\n \"subCostCenterName\": \"\",\n \"amount\": \"\"\n }\n ]\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "05f1b89b-ac12-496b-aa74-34c1e906c45a", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "journal-entries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Journal entry ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"accountingDate\": \"\",\n \"fiscalYear\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"companyId\": \"\",\n \"activityId\": \"\",\n \"accountingBook\": \"\",\n \"entryType\": \"COBRO\",\n \"lines\": [\n {\n \"lineNumber\": \"\",\n \"debit\": \"\",\n \"accountingAccountId\": \"\",\n \"offsetAccountId\": \"\",\n \"activityId\": \"\",\n \"amount\": \"\",\n \"concept\": \"\",\n \"extension\": \"\",\n \"costCenterAllocations\": [\n {\n \"costCenterId\": \"\",\n \"subCostCenterId\": \"\",\n \"amount\": \"\"\n },\n {\n \"costCenterId\": \"\",\n \"subCostCenterId\": \"\",\n \"amount\": \"\"\n }\n ]\n },\n {\n \"lineNumber\": \"\",\n \"debit\": \"\",\n \"accountingAccountId\": \"\",\n \"offsetAccountId\": \"\",\n \"activityId\": \"\",\n \"amount\": \"\",\n \"concept\": \"\",\n \"extension\": \"\",\n \"costCenterAllocations\": [\n {\n \"costCenterId\": \"\",\n \"subCostCenterId\": \"\",\n \"amount\": \"\"\n },\n {\n \"costCenterId\": \"\",\n \"subCostCenterId\": \"\",\n \"amount\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ac015131-89de-4d22-9e97-dd266eb8884a", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "journal-entries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Journal entry ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"accountingDate\": \"\",\n \"fiscalYear\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"companyId\": \"\",\n \"activityId\": \"\",\n \"accountingBook\": \"\",\n \"entryType\": \"COBRO\",\n \"lines\": [\n {\n \"lineNumber\": \"\",\n \"debit\": \"\",\n \"accountingAccountId\": \"\",\n \"offsetAccountId\": \"\",\n \"activityId\": \"\",\n \"amount\": \"\",\n \"concept\": \"\",\n \"extension\": \"\",\n \"costCenterAllocations\": [\n {\n \"costCenterId\": \"\",\n \"subCostCenterId\": \"\",\n \"amount\": \"\"\n },\n {\n \"costCenterId\": \"\",\n \"subCostCenterId\": \"\",\n \"amount\": \"\"\n }\n ]\n },\n {\n \"lineNumber\": \"\",\n \"debit\": \"\",\n \"accountingAccountId\": \"\",\n \"offsetAccountId\": \"\",\n \"activityId\": \"\",\n \"amount\": \"\",\n \"concept\": \"\",\n \"extension\": \"\",\n \"costCenterAllocations\": [\n {\n \"costCenterId\": \"\",\n \"subCostCenterId\": \"\",\n \"amount\": \"\"\n },\n {\n \"costCenterId\": \"\",\n \"subCostCenterId\": \"\",\n \"amount\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c35ab412-f538-4d91-8aac-a7f2ccde1e3f", "name": "Authenticated user is missing the `EDITAR_ASIENTOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "journal-entries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Journal entry ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"accountingDate\": \"\",\n \"fiscalYear\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"companyId\": \"\",\n \"activityId\": \"\",\n \"accountingBook\": \"\",\n \"entryType\": \"COBRO\",\n \"lines\": [\n {\n \"lineNumber\": \"\",\n \"debit\": \"\",\n \"accountingAccountId\": \"\",\n \"offsetAccountId\": \"\",\n \"activityId\": \"\",\n \"amount\": \"\",\n \"concept\": \"\",\n \"extension\": \"\",\n \"costCenterAllocations\": [\n {\n \"costCenterId\": \"\",\n \"subCostCenterId\": \"\",\n \"amount\": \"\"\n },\n {\n \"costCenterId\": \"\",\n \"subCostCenterId\": \"\",\n \"amount\": \"\"\n }\n ]\n },\n {\n \"lineNumber\": \"\",\n \"debit\": \"\",\n \"accountingAccountId\": \"\",\n \"offsetAccountId\": \"\",\n \"activityId\": \"\",\n \"amount\": \"\",\n \"concept\": \"\",\n \"extension\": \"\",\n \"costCenterAllocations\": [\n {\n \"costCenterId\": \"\",\n \"subCostCenterId\": \"\",\n \"amount\": \"\"\n },\n {\n \"costCenterId\": \"\",\n \"subCostCenterId\": \"\",\n \"amount\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "550fbe3d-485a-46d0-9d67-520749a1b18e", "name": "Journal entry not found", "originalRequest": { "url": { "path": [ "api", "v2", "journal-entries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Journal entry ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"accountingDate\": \"\",\n \"fiscalYear\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"companyId\": \"\",\n \"activityId\": \"\",\n \"accountingBook\": \"\",\n \"entryType\": \"COBRO\",\n \"lines\": [\n {\n \"lineNumber\": \"\",\n \"debit\": \"\",\n \"accountingAccountId\": \"\",\n \"offsetAccountId\": \"\",\n \"activityId\": \"\",\n \"amount\": \"\",\n \"concept\": \"\",\n \"extension\": \"\",\n \"costCenterAllocations\": [\n {\n \"costCenterId\": \"\",\n \"subCostCenterId\": \"\",\n \"amount\": \"\"\n },\n {\n \"costCenterId\": \"\",\n \"subCostCenterId\": \"\",\n \"amount\": \"\"\n }\n ]\n },\n {\n \"lineNumber\": \"\",\n \"debit\": \"\",\n \"accountingAccountId\": \"\",\n \"offsetAccountId\": \"\",\n \"activityId\": \"\",\n \"amount\": \"\",\n \"concept\": \"\",\n \"extension\": \"\",\n \"costCenterAllocations\": [\n {\n \"costCenterId\": \"\",\n \"subCostCenterId\": \"\",\n \"amount\": \"\"\n },\n {\n \"costCenterId\": \"\",\n \"subCostCenterId\": \"\",\n \"amount\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "acb86ec5-a275-4c5b-9901-e26423ef5a29", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "journal-entries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Journal entry ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"accountingDate\": \"\",\n \"fiscalYear\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"companyId\": \"\",\n \"activityId\": \"\",\n \"accountingBook\": \"\",\n \"entryType\": \"COBRO\",\n \"lines\": [\n {\n \"lineNumber\": \"\",\n \"debit\": \"\",\n \"accountingAccountId\": \"\",\n \"offsetAccountId\": \"\",\n \"activityId\": \"\",\n \"amount\": \"\",\n \"concept\": \"\",\n \"extension\": \"\",\n \"costCenterAllocations\": [\n {\n \"costCenterId\": \"\",\n \"subCostCenterId\": \"\",\n \"amount\": \"\"\n },\n {\n \"costCenterId\": \"\",\n \"subCostCenterId\": \"\",\n \"amount\": \"\"\n }\n ]\n },\n {\n \"lineNumber\": \"\",\n \"debit\": \"\",\n \"accountingAccountId\": \"\",\n \"offsetAccountId\": \"\",\n \"activityId\": \"\",\n \"amount\": \"\",\n \"concept\": \"\",\n \"extension\": \"\",\n \"costCenterAllocations\": [\n {\n \"costCenterId\": \"\",\n \"subCostCenterId\": \"\",\n \"amount\": \"\"\n },\n {\n \"costCenterId\": \"\",\n \"subCostCenterId\": \"\",\n \"amount\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "59a1636c-3489-44f8-a61c-739276975741", "name": "Delete journal entry", "request": { "name": "Delete journal entry", "description": { "content": "Deletes a manual journal entry (`entryType=ASI`). System-generated entries must be removed from their source document.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "journal-entries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Journal entry ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "d4180b21-a4f5-4c32-a44e-096e76cb8d6c", "name": "Journal entry deleted", "originalRequest": { "url": { "path": [ "api", "v2", "journal-entries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Journal entry ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f71a1f2b-fa47-4684-80ac-f56ab53a195d", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "journal-entries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Journal entry ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "32d458f6-7ad8-4872-a6f3-96d3659abc62", "name": "Authenticated user is missing the `BORRAR_ASIENTOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "journal-entries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Journal entry ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0d7ea739-1f6c-465f-beb8-34194c01e189", "name": "Journal entry not found", "originalRequest": { "url": { "path": [ "api", "v2", "journal-entries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Journal entry ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2af2b5aa-aec1-4022-8aa9-15b199604e7c", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "journal-entries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Journal entry ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ee3de559-9066-4864-915e-fe241d03028d", "name": "Merge-patch journal entry", "request": { "name": "Merge-patch journal entry", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "journal-entries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Journal entry ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "a6604491-8e72-43bc-bc1e-6a233a9e125d", "name": "Journal entry patched", "originalRequest": { "url": { "path": [ "api", "v2", "journal-entries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Journal entry ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"series\": \"\",\n \"entryNumber\": \"\",\n \"accountingDate\": \"\",\n \"fiscalYear\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"activityId\": \"\",\n \"activityName\": \"\",\n \"accountingBook\": \"\",\n \"entryType\": \"REG\",\n \"predefinedDocument\": \"\",\n \"lockType\": \"\",\n \"modified\": \"\",\n \"balanced\": \"\",\n \"totalDebit\": \"\",\n \"totalCredit\": \"\",\n \"balanceDifference\": \"\",\n \"invoiceId\": \"\",\n \"paymentId\": \"\",\n \"payrollId\": \"\",\n \"cashRegisterId\": \"\",\n \"lines\": [\n {\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"viewLineNumber\": \"\",\n \"debit\": \"\",\n \"accountingAccountId\": \"\",\n \"accountingAccountName\": \"\",\n \"offsetAccountId\": \"\",\n \"offsetAccountName\": \"\",\n \"activityId\": \"\",\n \"activityName\": \"\",\n \"amount\": \"\",\n \"concept\": \"\",\n \"extension\": \"\",\n \"invoiceLineId\": \"\",\n \"costCenterAllocations\": [\n {\n \"id\": \"\",\n \"costCenterId\": \"\",\n \"costCenterName\": \"\",\n \"subCostCenterId\": \"\",\n \"subCostCenterName\": \"\",\n \"amount\": \"\"\n },\n {\n \"id\": \"\",\n \"costCenterId\": \"\",\n \"costCenterName\": \"\",\n \"subCostCenterId\": \"\",\n \"subCostCenterName\": \"\",\n \"amount\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"viewLineNumber\": \"\",\n \"debit\": \"\",\n \"accountingAccountId\": \"\",\n \"accountingAccountName\": \"\",\n \"offsetAccountId\": \"\",\n \"offsetAccountName\": \"\",\n \"activityId\": \"\",\n \"activityName\": \"\",\n \"amount\": \"\",\n \"concept\": \"\",\n \"extension\": \"\",\n \"invoiceLineId\": \"\",\n \"costCenterAllocations\": [\n {\n \"id\": \"\",\n \"costCenterId\": \"\",\n \"costCenterName\": \"\",\n \"subCostCenterId\": \"\",\n \"subCostCenterName\": \"\",\n \"amount\": \"\"\n },\n {\n \"id\": \"\",\n \"costCenterId\": \"\",\n \"costCenterName\": \"\",\n \"subCostCenterId\": \"\",\n \"subCostCenterName\": \"\",\n \"amount\": \"\"\n }\n ]\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "185f5dd2-f98b-4d29-9de5-f35eb6e72bb8", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details. Also returned for malformed merge-patch payloads.", "originalRequest": { "url": { "path": [ "api", "v2", "journal-entries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Journal entry ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ea3b6b70-4470-4275-b87b-e894aeb72960", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "journal-entries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Journal entry ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "521c5536-6758-41b9-9cfa-9da326167cdf", "name": "Authenticated user is missing the `EDITAR_ASIENTOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "journal-entries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Journal entry ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "94679d09-5b66-4b20-9189-d8315c2c7e18", "name": "Journal entry not found", "originalRequest": { "url": { "path": [ "api", "v2", "journal-entries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Journal entry ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e78e7c37-75ca-48fb-ae87-f174e0703cf1", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "journal-entries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Journal entry ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "e1f75831-2486-4159-8805-83c7b5de1b41", "name": "List journal entries", "request": { "name": "List journal entries", "description": { "content": "Returns a paginated list of journal entries with envelope `{data, totalCount, skip, limit, hasMore}`. Supports optional RSQL `filter`, `sort` (default `accountingDate:desc`), `skip`/`limit` pagination and `modifiedAfter`/`modifiedBefore` bookends.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "journal-entries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "accountingDate:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "529f75dc-16f3-4d59-a774-0bc52247ec64", "name": "Page of journal entries", "originalRequest": { "url": { "path": [ "api", "v2", "journal-entries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "accountingDate:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a686d2b5-5170-464d-b6e1-89cac854fe74", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "journal-entries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "accountingDate:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f281b6f0-4483-449b-9a53-fd9d7408c5a6", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "journal-entries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "accountingDate:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7c17dc55-6ce9-40ad-a9d8-9011fe08e2f5", "name": "Authenticated user is missing the `VER_ASIENTOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "journal-entries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "accountingDate:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3c7bb469-6714-4143-a52a-a9bccc7b0051", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "journal-entries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "accountingDate:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0929b2cf-39e4-4a7f-b8e6-70a8e1f5a473", "name": "Create journal entry", "request": { "name": "Create journal entry", "description": { "content": "Creates a new manual journal entry via the internal commands gateway.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "journal-entries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"accountingDate\": \"\",\n \"fiscalYear\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"companyId\": \"\",\n \"activityId\": \"\",\n \"accountingBook\": \"\",\n \"entryType\": \"COBRO\",\n \"lines\": [\n {\n \"lineNumber\": \"\",\n \"debit\": \"\",\n \"accountingAccountId\": \"\",\n \"offsetAccountId\": \"\",\n \"activityId\": \"\",\n \"amount\": \"\",\n \"concept\": \"\",\n \"extension\": \"\",\n \"costCenterAllocations\": [\n {\n \"costCenterId\": \"\",\n \"subCostCenterId\": \"\",\n \"amount\": \"\"\n },\n {\n \"costCenterId\": \"\",\n \"subCostCenterId\": \"\",\n \"amount\": \"\"\n }\n ]\n },\n {\n \"lineNumber\": \"\",\n \"debit\": \"\",\n \"accountingAccountId\": \"\",\n \"offsetAccountId\": \"\",\n \"activityId\": \"\",\n \"amount\": \"\",\n \"concept\": \"\",\n \"extension\": \"\",\n \"costCenterAllocations\": [\n {\n \"costCenterId\": \"\",\n \"subCostCenterId\": \"\",\n \"amount\": \"\"\n },\n {\n \"costCenterId\": \"\",\n \"subCostCenterId\": \"\",\n \"amount\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "d86b7448-a53c-42b5-a689-179973f864d9", "name": "Journal entry created", "originalRequest": { "url": { "path": [ "api", "v2", "journal-entries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"accountingDate\": \"\",\n \"fiscalYear\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"companyId\": \"\",\n \"activityId\": \"\",\n \"accountingBook\": \"\",\n \"entryType\": \"COBRO\",\n \"lines\": [\n {\n \"lineNumber\": \"\",\n \"debit\": \"\",\n \"accountingAccountId\": \"\",\n \"offsetAccountId\": \"\",\n \"activityId\": \"\",\n \"amount\": \"\",\n \"concept\": \"\",\n \"extension\": \"\",\n \"costCenterAllocations\": [\n {\n \"costCenterId\": \"\",\n \"subCostCenterId\": \"\",\n \"amount\": \"\"\n },\n {\n \"costCenterId\": \"\",\n \"subCostCenterId\": \"\",\n \"amount\": \"\"\n }\n ]\n },\n {\n \"lineNumber\": \"\",\n \"debit\": \"\",\n \"accountingAccountId\": \"\",\n \"offsetAccountId\": \"\",\n \"activityId\": \"\",\n \"amount\": \"\",\n \"concept\": \"\",\n \"extension\": \"\",\n \"costCenterAllocations\": [\n {\n \"costCenterId\": \"\",\n \"subCostCenterId\": \"\",\n \"amount\": \"\"\n },\n {\n \"costCenterId\": \"\",\n \"subCostCenterId\": \"\",\n \"amount\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"series\": \"\",\n \"entryNumber\": \"\",\n \"accountingDate\": \"\",\n \"fiscalYear\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"activityId\": \"\",\n \"activityName\": \"\",\n \"accountingBook\": \"\",\n \"entryType\": \"REG\",\n \"predefinedDocument\": \"\",\n \"lockType\": \"\",\n \"modified\": \"\",\n \"balanced\": \"\",\n \"totalDebit\": \"\",\n \"totalCredit\": \"\",\n \"balanceDifference\": \"\",\n \"invoiceId\": \"\",\n \"paymentId\": \"\",\n \"payrollId\": \"\",\n \"cashRegisterId\": \"\",\n \"lines\": [\n {\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"viewLineNumber\": \"\",\n \"debit\": \"\",\n \"accountingAccountId\": \"\",\n \"accountingAccountName\": \"\",\n \"offsetAccountId\": \"\",\n \"offsetAccountName\": \"\",\n \"activityId\": \"\",\n \"activityName\": \"\",\n \"amount\": \"\",\n \"concept\": \"\",\n \"extension\": \"\",\n \"invoiceLineId\": \"\",\n \"costCenterAllocations\": [\n {\n \"id\": \"\",\n \"costCenterId\": \"\",\n \"costCenterName\": \"\",\n \"subCostCenterId\": \"\",\n \"subCostCenterName\": \"\",\n \"amount\": \"\"\n },\n {\n \"id\": \"\",\n \"costCenterId\": \"\",\n \"costCenterName\": \"\",\n \"subCostCenterId\": \"\",\n \"subCostCenterName\": \"\",\n \"amount\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"viewLineNumber\": \"\",\n \"debit\": \"\",\n \"accountingAccountId\": \"\",\n \"accountingAccountName\": \"\",\n \"offsetAccountId\": \"\",\n \"offsetAccountName\": \"\",\n \"activityId\": \"\",\n \"activityName\": \"\",\n \"amount\": \"\",\n \"concept\": \"\",\n \"extension\": \"\",\n \"invoiceLineId\": \"\",\n \"costCenterAllocations\": [\n {\n \"id\": \"\",\n \"costCenterId\": \"\",\n \"costCenterName\": \"\",\n \"subCostCenterId\": \"\",\n \"subCostCenterName\": \"\",\n \"amount\": \"\"\n },\n {\n \"id\": \"\",\n \"costCenterId\": \"\",\n \"costCenterName\": \"\",\n \"subCostCenterId\": \"\",\n \"subCostCenterName\": \"\",\n \"amount\": \"\"\n }\n ]\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "06ac052d-df4a-4f65-8a6d-c0173fb07b33", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "journal-entries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"accountingDate\": \"\",\n \"fiscalYear\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"companyId\": \"\",\n \"activityId\": \"\",\n \"accountingBook\": \"\",\n \"entryType\": \"COBRO\",\n \"lines\": [\n {\n \"lineNumber\": \"\",\n \"debit\": \"\",\n \"accountingAccountId\": \"\",\n \"offsetAccountId\": \"\",\n \"activityId\": \"\",\n \"amount\": \"\",\n \"concept\": \"\",\n \"extension\": \"\",\n \"costCenterAllocations\": [\n {\n \"costCenterId\": \"\",\n \"subCostCenterId\": \"\",\n \"amount\": \"\"\n },\n {\n \"costCenterId\": \"\",\n \"subCostCenterId\": \"\",\n \"amount\": \"\"\n }\n ]\n },\n {\n \"lineNumber\": \"\",\n \"debit\": \"\",\n \"accountingAccountId\": \"\",\n \"offsetAccountId\": \"\",\n \"activityId\": \"\",\n \"amount\": \"\",\n \"concept\": \"\",\n \"extension\": \"\",\n \"costCenterAllocations\": [\n {\n \"costCenterId\": \"\",\n \"subCostCenterId\": \"\",\n \"amount\": \"\"\n },\n {\n \"costCenterId\": \"\",\n \"subCostCenterId\": \"\",\n \"amount\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "59401464-4abc-44c2-8838-4674c729f9c4", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "journal-entries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"accountingDate\": \"\",\n \"fiscalYear\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"companyId\": \"\",\n \"activityId\": \"\",\n \"accountingBook\": \"\",\n \"entryType\": \"COBRO\",\n \"lines\": [\n {\n \"lineNumber\": \"\",\n \"debit\": \"\",\n \"accountingAccountId\": \"\",\n \"offsetAccountId\": \"\",\n \"activityId\": \"\",\n \"amount\": \"\",\n \"concept\": \"\",\n \"extension\": \"\",\n \"costCenterAllocations\": [\n {\n \"costCenterId\": \"\",\n \"subCostCenterId\": \"\",\n \"amount\": \"\"\n },\n {\n \"costCenterId\": \"\",\n \"subCostCenterId\": \"\",\n \"amount\": \"\"\n }\n ]\n },\n {\n \"lineNumber\": \"\",\n \"debit\": \"\",\n \"accountingAccountId\": \"\",\n \"offsetAccountId\": \"\",\n \"activityId\": \"\",\n \"amount\": \"\",\n \"concept\": \"\",\n \"extension\": \"\",\n \"costCenterAllocations\": [\n {\n \"costCenterId\": \"\",\n \"subCostCenterId\": \"\",\n \"amount\": \"\"\n },\n {\n \"costCenterId\": \"\",\n \"subCostCenterId\": \"\",\n \"amount\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1eb01c6f-2777-47e2-a6a6-21c85247c699", "name": "Authenticated user is missing the `CREAR_ASIENTOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "journal-entries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"accountingDate\": \"\",\n \"fiscalYear\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"companyId\": \"\",\n \"activityId\": \"\",\n \"accountingBook\": \"\",\n \"entryType\": \"COBRO\",\n \"lines\": [\n {\n \"lineNumber\": \"\",\n \"debit\": \"\",\n \"accountingAccountId\": \"\",\n \"offsetAccountId\": \"\",\n \"activityId\": \"\",\n \"amount\": \"\",\n \"concept\": \"\",\n \"extension\": \"\",\n \"costCenterAllocations\": [\n {\n \"costCenterId\": \"\",\n \"subCostCenterId\": \"\",\n \"amount\": \"\"\n },\n {\n \"costCenterId\": \"\",\n \"subCostCenterId\": \"\",\n \"amount\": \"\"\n }\n ]\n },\n {\n \"lineNumber\": \"\",\n \"debit\": \"\",\n \"accountingAccountId\": \"\",\n \"offsetAccountId\": \"\",\n \"activityId\": \"\",\n \"amount\": \"\",\n \"concept\": \"\",\n \"extension\": \"\",\n \"costCenterAllocations\": [\n {\n \"costCenterId\": \"\",\n \"subCostCenterId\": \"\",\n \"amount\": \"\"\n },\n {\n \"costCenterId\": \"\",\n \"subCostCenterId\": \"\",\n \"amount\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3e08c121-6069-4b3b-b8b2-c3ac89809498", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "journal-entries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"accountingDate\": \"\",\n \"fiscalYear\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"companyId\": \"\",\n \"activityId\": \"\",\n \"accountingBook\": \"\",\n \"entryType\": \"COBRO\",\n \"lines\": [\n {\n \"lineNumber\": \"\",\n \"debit\": \"\",\n \"accountingAccountId\": \"\",\n \"offsetAccountId\": \"\",\n \"activityId\": \"\",\n \"amount\": \"\",\n \"concept\": \"\",\n \"extension\": \"\",\n \"costCenterAllocations\": [\n {\n \"costCenterId\": \"\",\n \"subCostCenterId\": \"\",\n \"amount\": \"\"\n },\n {\n \"costCenterId\": \"\",\n \"subCostCenterId\": \"\",\n \"amount\": \"\"\n }\n ]\n },\n {\n \"lineNumber\": \"\",\n \"debit\": \"\",\n \"accountingAccountId\": \"\",\n \"offsetAccountId\": \"\",\n \"activityId\": \"\",\n \"amount\": \"\",\n \"concept\": \"\",\n \"extension\": \"\",\n \"costCenterAllocations\": [\n {\n \"costCenterId\": \"\",\n \"subCostCenterId\": \"\",\n \"amount\": \"\"\n },\n {\n \"costCenterId\": \"\",\n \"subCostCenterId\": \"\",\n \"amount\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "new", "description": "", "item": [ { "id": "ad2fb224-7770-4e75-a4f5-90f2701cd4a5", "name": "Prototype journal entry for a creation form", "request": { "name": "Prototype journal entry for a creation form", "description": { "content": "Returns a non-persisted journal entry pre-populated with backend defaults (`enabled=true`, `draft=true`, current company, default series and fiscal year). Optional JSON hints: `companyId`, `activityId`, `copyFromId`. Call `POST /api/v2/journal-entries` afterwards to persist.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "journal-entries", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "5e8fd3d6-4037-49ae-9396-c392762a099b", "name": "Journal entry prototype with defaults", "originalRequest": { "url": { "path": [ "api", "v2", "journal-entries", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"series\": \"\",\n \"entryNumber\": \"\",\n \"accountingDate\": \"\",\n \"fiscalYear\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"activityId\": \"\",\n \"activityName\": \"\",\n \"accountingBook\": \"\",\n \"entryType\": \"REG\",\n \"predefinedDocument\": \"\",\n \"lockType\": \"\",\n \"modified\": \"\",\n \"balanced\": \"\",\n \"totalDebit\": \"\",\n \"totalCredit\": \"\",\n \"balanceDifference\": \"\",\n \"invoiceId\": \"\",\n \"paymentId\": \"\",\n \"payrollId\": \"\",\n \"cashRegisterId\": \"\",\n \"lines\": [\n {\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"viewLineNumber\": \"\",\n \"debit\": \"\",\n \"accountingAccountId\": \"\",\n \"accountingAccountName\": \"\",\n \"offsetAccountId\": \"\",\n \"offsetAccountName\": \"\",\n \"activityId\": \"\",\n \"activityName\": \"\",\n \"amount\": \"\",\n \"concept\": \"\",\n \"extension\": \"\",\n \"invoiceLineId\": \"\",\n \"costCenterAllocations\": [\n {\n \"id\": \"\",\n \"costCenterId\": \"\",\n \"costCenterName\": \"\",\n \"subCostCenterId\": \"\",\n \"subCostCenterName\": \"\",\n \"amount\": \"\"\n },\n {\n \"id\": \"\",\n \"costCenterId\": \"\",\n \"costCenterName\": \"\",\n \"subCostCenterId\": \"\",\n \"subCostCenterName\": \"\",\n \"amount\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"viewLineNumber\": \"\",\n \"debit\": \"\",\n \"accountingAccountId\": \"\",\n \"accountingAccountName\": \"\",\n \"offsetAccountId\": \"\",\n \"offsetAccountName\": \"\",\n \"activityId\": \"\",\n \"activityName\": \"\",\n \"amount\": \"\",\n \"concept\": \"\",\n \"extension\": \"\",\n \"invoiceLineId\": \"\",\n \"costCenterAllocations\": [\n {\n \"id\": \"\",\n \"costCenterId\": \"\",\n \"costCenterName\": \"\",\n \"subCostCenterId\": \"\",\n \"subCostCenterName\": \"\",\n \"amount\": \"\"\n },\n {\n \"id\": \"\",\n \"costCenterId\": \"\",\n \"costCenterName\": \"\",\n \"subCostCenterId\": \"\",\n \"subCostCenterName\": \"\",\n \"amount\": \"\"\n }\n ]\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "01cc819d-6252-439c-a03f-07f761c480f5", "name": "Invalid prepare-create hints", "originalRequest": { "url": { "path": [ "api", "v2", "journal-entries", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fd7b3051-af55-4bf9-ac12-645383d7ad43", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "journal-entries", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ee95cbab-e682-4c54-a84c-72f028857854", "name": "Authenticated user is missing the `CREAR_ASIENTOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "journal-entries", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8835fdb6-d531-45b8-9400-d26bbaa8485f", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "journal-entries", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "item-types", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "c2176b24-e0f1-4f6c-aa99-ea4fefc35cc4", "name": "Get item type by ID", "request": { "name": "Get item type by ID", "description": { "content": "Returns the item type including associatedAccounts. The response carries a strong `ETag` header (always `\"0\"` ÔÇö TipoArticulo is not versioned).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "item-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Item type ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "a93fd688-0764-4e53-a4bb-738fc46b4fac", "name": "Item type found", "originalRequest": { "url": { "path": [ "api", "v2", "item-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Item type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"itemCategory\": \"\",\n \"associatedAccounts\": [\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n },\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1e79da97-c6e8-42d6-8ffa-3f18339fbb16", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "item-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Item type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "84899d2e-1462-4595-95be-c3b812372e66", "name": "Authenticated user is missing the `VER_TIPOSARTICULOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "item-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Item type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "259e55b0-48d7-4c75-a559-14669e0aefce", "name": "Item type not found", "originalRequest": { "url": { "path": [ "api", "v2", "item-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Item type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a4c88a43-a4cc-4134-8e99-aa18c183e732", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "item-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Item type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e3e19f95-7c80-43ef-8eb1-6ea71f7e49db", "name": "Update item type", "request": { "name": "Update item type", "description": { "content": "Full replacement. On update, null associatedAccounts leaves existing children untouched; [] clears; non-empty list replaces.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "item-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Item type ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"itemCategory\": \"\",\n \"associatedAccounts\": [\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n },\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "eb871274-2580-490f-b560-8f2d1e8cdb1e", "name": "Item type updated", "originalRequest": { "url": { "path": [ "api", "v2", "item-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Item type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"itemCategory\": \"\",\n \"associatedAccounts\": [\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n },\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"itemCategory\": \"\",\n \"associatedAccounts\": [\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n },\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b6894c61-5106-44b9-a4f2-df3668b86e96", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "item-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Item type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"itemCategory\": \"\",\n \"associatedAccounts\": [\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n },\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bba1f418-c1f1-47cd-9ee0-62450f94918b", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "item-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Item type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"itemCategory\": \"\",\n \"associatedAccounts\": [\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n },\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "843870df-9589-4269-93ff-b619bbb09762", "name": "Authenticated user is missing the `EDITAR_TIPOSARTICULOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "item-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Item type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"itemCategory\": \"\",\n \"associatedAccounts\": [\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n },\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bd8032d6-a1f3-418a-ae79-2375ffec2a71", "name": "Item type not found", "originalRequest": { "url": { "path": [ "api", "v2", "item-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Item type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"itemCategory\": \"\",\n \"associatedAccounts\": [\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n },\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c290af36-5bc2-43a0-9d68-cbf26ac57a94", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "item-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Item type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"itemCategory\": \"\",\n \"associatedAccounts\": [\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n },\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f26b5051-0749-4792-9c8e-664858dfe062", "name": "Delete item type", "request": { "name": "Delete item type", "description": { "content": "Deletes the item type. If-Match is accepted but ignored (TipoArticulo is not versioned).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "item-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Item type ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "599f0b64-e616-46fd-954f-946e370e9812", "name": "Item type deleted", "originalRequest": { "url": { "path": [ "api", "v2", "item-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Item type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3ca78bf4-0408-4741-a436-452b92678272", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "item-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Item type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "48a6c0e8-3c63-42a6-a1b6-639f90cb2bfc", "name": "Authenticated user is missing the `BORRAR_TIPOSARTICULOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "item-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Item type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cb73905d-3f21-4118-baf5-14b20aa725fe", "name": "Item type not found", "originalRequest": { "url": { "path": [ "api", "v2", "item-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Item type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6693ab0f-0aeb-4de5-bc2b-3bac8c59aceb", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "item-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Item type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "747efbd3-74ef-4d49-bbed-b53e8ac18a8e", "name": "Merge-patch item type", "request": { "name": "Merge-patch item type", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "item-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Item type ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "8282c0e9-2359-41cb-b08e-a295d830c4bc", "name": "Item type patched", "originalRequest": { "url": { "path": [ "api", "v2", "item-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Item type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"itemCategory\": \"\",\n \"associatedAccounts\": [\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n },\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "24952f89-355c-4a1e-9042-4eab14f8ca37", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details. Also returned for malformed merge-patch payloads.", "originalRequest": { "url": { "path": [ "api", "v2", "item-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Item type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "93676a97-33a3-4f01-b272-7ee16db6c6c6", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "item-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Item type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e7cb058a-5334-467b-8b25-91b4826ce764", "name": "Authenticated user is missing the `EDITAR_TIPOSARTICULOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "item-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Item type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "88b75985-ce73-4103-a1a7-a0be66190d74", "name": "Item type not found", "originalRequest": { "url": { "path": [ "api", "v2", "item-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Item type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8dd08215-9667-4db9-8b72-690ea3b4ae2b", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "item-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Item type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "b9d3ba82-8832-45a8-9c92-198be71e8728", "name": "List item types", "request": { "name": "List item types", "description": { "content": "Paginated list with optional RSQL filter and sort (default lastModifiedAt:desc). Child collections are omitted; use GET /{id} for associatedAccounts.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "item-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "86485239-06b9-4ae4-a6ea-0295354a9534", "name": "Page of item types", "originalRequest": { "url": { "path": [ "api", "v2", "item-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e56b4342-cc0f-4ccc-aa3c-a041da0d3ac3", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "item-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7bc66ae7-51c1-4bc1-9202-d7067da0f8aa", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "item-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "712e5b5a-216e-446b-b779-c5e95edf5e71", "name": "Authenticated user is missing the `VER_TIPOSARTICULOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "item-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "936065c7-7311-435f-a986-1957f67cca86", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "item-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f41d41ed-9855-46a9-b40e-d3262ae69139", "name": "Create item type", "request": { "name": "Create item type", "description": { "content": "Persists via the internal commands gateway. associatedAccounts: null leaves empty; [] clears; list replaces.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "item-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"itemCategory\": \"\",\n \"associatedAccounts\": [\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n },\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "8c3a0e1d-95bd-48bf-bd7c-28086dae70f4", "name": "Item type created", "originalRequest": { "url": { "path": [ "api", "v2", "item-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"itemCategory\": \"\",\n \"associatedAccounts\": [\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n },\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"itemCategory\": \"\",\n \"associatedAccounts\": [\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n },\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d0b6e2a2-4d65-45de-8300-07d2e6b60654", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "item-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"itemCategory\": \"\",\n \"associatedAccounts\": [\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n },\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1c0febe0-bf7d-459e-9ce2-d827ca810752", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "item-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"itemCategory\": \"\",\n \"associatedAccounts\": [\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n },\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b737d502-0a98-4331-ae8d-63fcf8284aed", "name": "Authenticated user is missing the `CREAR_TIPOSARTICULOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "item-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"itemCategory\": \"\",\n \"associatedAccounts\": [\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n },\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "21e595c2-4e7f-4514-81fe-c99ef56ecee4", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "item-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"itemCategory\": \"\",\n \"associatedAccounts\": [\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n },\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "new", "description": "", "item": [ { "id": "ea1c38b6-cc27-4abb-8552-1f245093e4c6", "name": "Prototype an item type for a creation form", "request": { "name": "Prototype an item type for a creation form", "description": { "content": "Non-persisted defaults: current company, enabled=true. Optional JSON hints: companyId, itemCategory, copyFromId.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "item-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "d9677c6e-6f3b-406a-8c51-2c7b2b591d44", "name": "Item type prototype", "originalRequest": { "url": { "path": [ "api", "v2", "item-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"itemCategory\": \"\",\n \"associatedAccounts\": [\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n },\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d607ee83-1ffc-445e-ac5b-aa93682608d3", "name": "Hint references an unknown entity", "originalRequest": { "url": { "path": [ "api", "v2", "item-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "95844758-650e-46a7-b72a-328e531e619d", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "item-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e68c5c42-f226-4a2d-b53b-10b3306f0132", "name": "Authenticated user is missing the `CREAR_TIPOSARTICULOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "item-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2d4abe29-2c93-4f86-bb34-c7fd0cbb930b", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "item-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "inventory-counts", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "3fb39502-1229-4ff3-b68f-781ad1a2ec6b", "name": "Get inventory count by ID", "request": { "name": "Get inventory count by ID", "description": { "content": "Returns a single inventory count, including line detail (counted vs calculated quantities) and references to the generated stock adjustments when finalised. The response carries a strong `ETag` header with the current version.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "inventory-counts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Inventory count ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "4e9c6074-be13-4099-b3c7-55a414bbe7b2", "name": "Inventory count found", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-counts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inventory count ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"status\": \"FINALIZED\",\n \"code\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"documentDate\": \"\",\n \"internalRef\": \"\",\n \"notes\": \"\",\n \"adjustmentReasonId\": \"\",\n \"adjustmentReasonName\": \"\",\n \"fullInventory\": \"\",\n \"skipReservedStock\": \"\",\n \"stockBalanced\": \"\",\n \"totalCountedUnits\": \"\",\n \"totalCalculatedUnits\": \"\",\n \"totalCountedCost\": \"\",\n \"totalCalculatedCost\": \"\",\n \"lines\": [\n {\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productId\": \"\",\n \"productName\": \"\",\n \"productSku\": \"\",\n \"countedQuantity\": \"\",\n \"calculatedQuantity\": \"\",\n \"difference\": \"\",\n \"unitCost\": \"\"\n },\n {\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productId\": \"\",\n \"productName\": \"\",\n \"productSku\": \"\",\n \"countedQuantity\": \"\",\n \"calculatedQuantity\": \"\",\n \"difference\": \"\",\n \"unitCost\": \"\"\n }\n ],\n \"stockAdjustments\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"direction\": \"OUT\",\n \"totalQuantity\": \"\",\n \"lineCount\": \"\",\n \"href\": \"\"\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"direction\": \"IN\",\n \"totalQuantity\": \"\",\n \"lineCount\": \"\",\n \"href\": \"\"\n }\n ],\n \"finalizedAt\": \"\",\n \"finalizedBy\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4ef4d4c7-f3d3-4998-84e3-b6c8f517e669", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-counts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inventory count ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2f900ea4-49d8-4891-97d8-76cf097efaeb", "name": "Authenticated user is missing the `VER_INVENTARIOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-counts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inventory count ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8d9f9cfc-c236-4dac-9396-644de88d801b", "name": "Inventory count not found", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-counts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inventory count ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1d7bbdbe-3ac7-4231-b220-1d02c4cab204", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-counts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inventory count ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ee51d5cc-c13b-4ae2-8688-b5bfe0891d12", "name": "Update inventory count (DRAFT only)", "request": { "name": "Update inventory count (DRAFT only)", "description": { "content": "Replaces the editable fields of a DRAFT inventory count. The `warehouseId` cannot be changed; if `lines` is supplied, the line set is fully replaced and the calculated quantities are recomputed against the current stock. Send the `If-Match` header with the current ETag for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "inventory-counts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Inventory count ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"warehouseId\": \"\",\n \"documentDate\": \"\",\n \"internalRef\": \"\",\n \"notes\": \"\",\n \"adjustmentReasonId\": \"\",\n \"fullInventory\": \"\",\n \"skipReservedStock\": \"\",\n \"finalize\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"countedQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"countedQuantity\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "542b9f4b-cb3f-4646-892b-e4115da56582", "name": "Inventory count updated", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-counts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inventory count ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"warehouseId\": \"\",\n \"documentDate\": \"\",\n \"internalRef\": \"\",\n \"notes\": \"\",\n \"adjustmentReasonId\": \"\",\n \"fullInventory\": \"\",\n \"skipReservedStock\": \"\",\n \"finalize\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"countedQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"countedQuantity\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"status\": \"FINALIZED\",\n \"code\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"documentDate\": \"\",\n \"internalRef\": \"\",\n \"notes\": \"\",\n \"adjustmentReasonId\": \"\",\n \"adjustmentReasonName\": \"\",\n \"fullInventory\": \"\",\n \"skipReservedStock\": \"\",\n \"stockBalanced\": \"\",\n \"totalCountedUnits\": \"\",\n \"totalCalculatedUnits\": \"\",\n \"totalCountedCost\": \"\",\n \"totalCalculatedCost\": \"\",\n \"lines\": [\n {\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productId\": \"\",\n \"productName\": \"\",\n \"productSku\": \"\",\n \"countedQuantity\": \"\",\n \"calculatedQuantity\": \"\",\n \"difference\": \"\",\n \"unitCost\": \"\"\n },\n {\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productId\": \"\",\n \"productName\": \"\",\n \"productSku\": \"\",\n \"countedQuantity\": \"\",\n \"calculatedQuantity\": \"\",\n \"difference\": \"\",\n \"unitCost\": \"\"\n }\n ],\n \"stockAdjustments\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"direction\": \"OUT\",\n \"totalQuantity\": \"\",\n \"lineCount\": \"\",\n \"href\": \"\"\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"direction\": \"IN\",\n \"totalQuantity\": \"\",\n \"lineCount\": \"\",\n \"href\": \"\"\n }\n ],\n \"finalizedAt\": \"\",\n \"finalizedBy\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "23b02559-8f30-4a57-abe9-3a33b0b53958", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-counts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inventory count ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"warehouseId\": \"\",\n \"documentDate\": \"\",\n \"internalRef\": \"\",\n \"notes\": \"\",\n \"adjustmentReasonId\": \"\",\n \"fullInventory\": \"\",\n \"skipReservedStock\": \"\",\n \"finalize\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"countedQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"countedQuantity\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "548acb6c-6215-42d4-b078-9eceba1095b4", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-counts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inventory count ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"warehouseId\": \"\",\n \"documentDate\": \"\",\n \"internalRef\": \"\",\n \"notes\": \"\",\n \"adjustmentReasonId\": \"\",\n \"fullInventory\": \"\",\n \"skipReservedStock\": \"\",\n \"finalize\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"countedQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"countedQuantity\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d9fde411-0dc9-4d00-b752-6f963bcde778", "name": "Authenticated user is missing the `EDITAR_INVENTARIOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-counts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inventory count ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"warehouseId\": \"\",\n \"documentDate\": \"\",\n \"internalRef\": \"\",\n \"notes\": \"\",\n \"adjustmentReasonId\": \"\",\n \"fullInventory\": \"\",\n \"skipReservedStock\": \"\",\n \"finalize\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"countedQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"countedQuantity\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "eb6afc2a-b11a-4c3d-ba87-b91ed11d3ea1", "name": "Inventory count not found", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-counts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inventory count ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"warehouseId\": \"\",\n \"documentDate\": \"\",\n \"internalRef\": \"\",\n \"notes\": \"\",\n \"adjustmentReasonId\": \"\",\n \"fullInventory\": \"\",\n \"skipReservedStock\": \"\",\n \"finalize\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"countedQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"countedQuantity\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e5d790aa-f598-4e7b-b4d9-83ad1f09ed62", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued. Also returned when the count is already FINALIZED.", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-counts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inventory count ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"warehouseId\": \"\",\n \"documentDate\": \"\",\n \"internalRef\": \"\",\n \"notes\": \"\",\n \"adjustmentReasonId\": \"\",\n \"fullInventory\": \"\",\n \"skipReservedStock\": \"\",\n \"finalize\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"countedQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"countedQuantity\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f35b9cc4-a143-43b0-bb2a-14ab708a045c", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-counts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inventory count ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"warehouseId\": \"\",\n \"documentDate\": \"\",\n \"internalRef\": \"\",\n \"notes\": \"\",\n \"adjustmentReasonId\": \"\",\n \"fullInventory\": \"\",\n \"skipReservedStock\": \"\",\n \"finalize\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"countedQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"countedQuantity\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "604ecca0-7575-49ee-8590-16fdb47696c3", "name": "Delete inventory count (DRAFT only)", "request": { "name": "Delete inventory count (DRAFT only)", "description": { "content": "Deletes a DRAFT inventory count. A FINALIZED count cannot be deleted; create a compensating `inventory-entry`/`inventory-exit` instead.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "inventory-counts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Inventory count ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "ce781ab4-04de-4b6d-95d1-9a685d13078c", "name": "Inventory count deleted", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-counts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inventory count ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ce9e5fbe-5ca8-48cb-b289-33e4a24d1e8b", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-counts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inventory count ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3f5f58dd-16fb-4304-88d0-9d5b71a50520", "name": "Authenticated user is missing the `BORRAR_INVENTARIOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-counts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inventory count ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fb8fafff-650b-462e-8b80-80e0ddd01628", "name": "Inventory count not found", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-counts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inventory count ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cb5da450-bd90-4b80-80ae-9d97f34004b3", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued. Also returned when the count is already FINALIZED.", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-counts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inventory count ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2a1ac200-0bf6-478a-abf9-89d2a1642eca", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-counts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inventory count ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "finalize", "description": "", "item": [ { "id": "f29348c1-75ad-430c-aff4-d716e8fd2ffe", "name": "Finalize inventory count", "request": { "name": "Finalize inventory count", "description": { "content": "Confirms a DRAFT inventory count and generates the resulting stock adjustments (entry for positive deltas, exit for negative ones). Returns the count with `status = FINALIZED` and the populated `stockAdjustments` references. Idempotency is explicit: calling finalize on an already FINALIZED count returns 409.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "inventory-counts", ":id", "finalize" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Inventory count ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "ca3131b8-bf12-4d2f-8339-17b876b1cade", "name": "Inventory count finalized", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-counts", ":id", "finalize" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inventory count ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"status\": \"FINALIZED\",\n \"code\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"documentDate\": \"\",\n \"internalRef\": \"\",\n \"notes\": \"\",\n \"adjustmentReasonId\": \"\",\n \"adjustmentReasonName\": \"\",\n \"fullInventory\": \"\",\n \"skipReservedStock\": \"\",\n \"stockBalanced\": \"\",\n \"totalCountedUnits\": \"\",\n \"totalCalculatedUnits\": \"\",\n \"totalCountedCost\": \"\",\n \"totalCalculatedCost\": \"\",\n \"lines\": [\n {\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productId\": \"\",\n \"productName\": \"\",\n \"productSku\": \"\",\n \"countedQuantity\": \"\",\n \"calculatedQuantity\": \"\",\n \"difference\": \"\",\n \"unitCost\": \"\"\n },\n {\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productId\": \"\",\n \"productName\": \"\",\n \"productSku\": \"\",\n \"countedQuantity\": \"\",\n \"calculatedQuantity\": \"\",\n \"difference\": \"\",\n \"unitCost\": \"\"\n }\n ],\n \"stockAdjustments\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"direction\": \"OUT\",\n \"totalQuantity\": \"\",\n \"lineCount\": \"\",\n \"href\": \"\"\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"direction\": \"IN\",\n \"totalQuantity\": \"\",\n \"lineCount\": \"\",\n \"href\": \"\"\n }\n ],\n \"finalizedAt\": \"\",\n \"finalizedBy\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3ade1014-7f36-47c4-9966-10478946c587", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-counts", ":id", "finalize" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inventory count ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5b847908-4c88-4e5d-a66e-93c869b7b546", "name": "Authenticated user is missing the `CUADRAR_STOCK` permission", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-counts", ":id", "finalize" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inventory count ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1f0dbc65-1fc0-464f-8c43-2cfb536b5664", "name": "Inventory count not found", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-counts", ":id", "finalize" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inventory count ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "de34da23-ce27-441c-bce6-2e15109c3072", "name": "Inventory count is already FINALIZED, or the supplied `If-Match` does not match the current version", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-counts", ":id", "finalize" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inventory count ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d8b4757c-acec-4296-bebc-8c6910b6f408", "name": "Operation would leave a product with negative stock", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-counts", ":id", "finalize" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inventory count ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2caedea2-818e-4d5b-8678-94c231dc5b2f", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-counts", ":id", "finalize" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inventory count ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "id": "9dafd971-4e2c-400e-815c-bc0a06833908", "name": "List inventory counts", "request": { "name": "List inventory counts", "description": { "content": "Returns a paginated list of inventory counts. Combine with `filter=stockBalanced==true` (or `false`) to narrow by lifecycle status.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "inventory-counts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "documentDate:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "bcc7fab1-7be6-4e2c-ad16-39b2853ae534", "name": "Page of inventory counts", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-counts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "documentDate:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c5a8232e-1c87-42dd-8459-6b38f24d1b69", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-counts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "documentDate:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8c0379ba-2ea8-45ce-85eb-765577983ef6", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-counts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "documentDate:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "04f212c4-9167-42f7-8771-f51ae450db3f", "name": "Authenticated user is missing the `VER_INVENTARIOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-counts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "documentDate:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f34412ba-90cf-444d-ac69-7a085239c933", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-counts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "documentDate:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "16696bb5-cdd8-4b13-9ac1-2e1d3ac32175", "name": "Create inventory count", "request": { "name": "Create inventory count", "description": { "content": "Creates a draft inventory count. The server runs the `agruparYCalcularDiferencias` step and returns the computed differences without moving stock. Set `finalize=true` to commit the count immediately in the same transaction (requires `CUADRAR_STOCK`).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "inventory-counts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"warehouseId\": \"\",\n \"documentDate\": \"\",\n \"internalRef\": \"\",\n \"notes\": \"\",\n \"adjustmentReasonId\": \"\",\n \"fullInventory\": \"\",\n \"skipReservedStock\": \"\",\n \"finalize\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"countedQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"countedQuantity\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "6b3ea0d1-4c2c-4ecb-9667-8c7c9655c935", "name": "Inventory count created (DRAFT or FINALIZED)", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-counts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"warehouseId\": \"\",\n \"documentDate\": \"\",\n \"internalRef\": \"\",\n \"notes\": \"\",\n \"adjustmentReasonId\": \"\",\n \"fullInventory\": \"\",\n \"skipReservedStock\": \"\",\n \"finalize\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"countedQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"countedQuantity\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"status\": \"FINALIZED\",\n \"code\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"documentDate\": \"\",\n \"internalRef\": \"\",\n \"notes\": \"\",\n \"adjustmentReasonId\": \"\",\n \"adjustmentReasonName\": \"\",\n \"fullInventory\": \"\",\n \"skipReservedStock\": \"\",\n \"stockBalanced\": \"\",\n \"totalCountedUnits\": \"\",\n \"totalCalculatedUnits\": \"\",\n \"totalCountedCost\": \"\",\n \"totalCalculatedCost\": \"\",\n \"lines\": [\n {\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productId\": \"\",\n \"productName\": \"\",\n \"productSku\": \"\",\n \"countedQuantity\": \"\",\n \"calculatedQuantity\": \"\",\n \"difference\": \"\",\n \"unitCost\": \"\"\n },\n {\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productId\": \"\",\n \"productName\": \"\",\n \"productSku\": \"\",\n \"countedQuantity\": \"\",\n \"calculatedQuantity\": \"\",\n \"difference\": \"\",\n \"unitCost\": \"\"\n }\n ],\n \"stockAdjustments\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"direction\": \"OUT\",\n \"totalQuantity\": \"\",\n \"lineCount\": \"\",\n \"href\": \"\"\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"direction\": \"IN\",\n \"totalQuantity\": \"\",\n \"lineCount\": \"\",\n \"href\": \"\"\n }\n ],\n \"finalizedAt\": \"\",\n \"finalizedBy\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d1f1cba8-2370-4c6a-96db-2b533bee661e", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-counts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"warehouseId\": \"\",\n \"documentDate\": \"\",\n \"internalRef\": \"\",\n \"notes\": \"\",\n \"adjustmentReasonId\": \"\",\n \"fullInventory\": \"\",\n \"skipReservedStock\": \"\",\n \"finalize\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"countedQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"countedQuantity\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0c0acce7-5d57-44f8-b5ab-b3c10385f0c6", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-counts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"warehouseId\": \"\",\n \"documentDate\": \"\",\n \"internalRef\": \"\",\n \"notes\": \"\",\n \"adjustmentReasonId\": \"\",\n \"fullInventory\": \"\",\n \"skipReservedStock\": \"\",\n \"finalize\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"countedQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"countedQuantity\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "22b4539d-05fc-4c36-ab81-b3164b1d6d22", "name": "Authenticated user is missing the `CREAR_INVENTARIOS` permission (or `CUADRAR_STOCK` when `finalize=true`)", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-counts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"warehouseId\": \"\",\n \"documentDate\": \"\",\n \"internalRef\": \"\",\n \"notes\": \"\",\n \"adjustmentReasonId\": \"\",\n \"fullInventory\": \"\",\n \"skipReservedStock\": \"\",\n \"finalize\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"countedQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"countedQuantity\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "aa9657a8-edd9-43a5-bb15-5cba1fc3fb56", "name": "Operation would leave a product with negative stock during finalisation", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-counts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"warehouseId\": \"\",\n \"documentDate\": \"\",\n \"internalRef\": \"\",\n \"notes\": \"\",\n \"adjustmentReasonId\": \"\",\n \"fullInventory\": \"\",\n \"skipReservedStock\": \"\",\n \"finalize\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"countedQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"countedQuantity\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9e6ff006-2ee8-4e6a-a565-59d33eadab3f", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-counts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"warehouseId\": \"\",\n \"documentDate\": \"\",\n \"internalRef\": \"\",\n \"notes\": \"\",\n \"adjustmentReasonId\": \"\",\n \"fullInventory\": \"\",\n \"skipReservedStock\": \"\",\n \"finalize\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"countedQuantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"countedQuantity\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "incoming-payments", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "b3d7c503-d355-455e-9617-96d0ccbcd7de", "name": "Get incoming payment by ID", "request": { "name": "Get incoming payment by ID", "description": { "content": "Returns a single incoming payment by its primary key. Returns 404 when the requested ID belongs to an outgoing payment.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "incoming-payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Incoming payment ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "17de45bb-45a8-4b52-8d4a-47619b387113", "name": "Incoming payment found", "originalRequest": { "url": { "path": [ "api", "v2", "incoming-payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Incoming payment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"RI\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2df785f6-f8a4-4ecd-b8f8-2d83d09caac1", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "incoming-payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Incoming payment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "999c60be-cc67-42ce-80d4-ac969bda0945", "name": "Authenticated user is missing the `VER_COBROS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "incoming-payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Incoming payment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "46cee117-dd61-4193-8919-c51265478a51", "name": "Incoming payment not found", "originalRequest": { "url": { "path": [ "api", "v2", "incoming-payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Incoming payment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "234cb802-0a61-4fff-a9aa-2627e229cf3e", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "incoming-payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Incoming payment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c12b023e-ed76-4a47-bfbe-d6d1a8242cf5", "name": "Update incoming payment", "request": { "name": "Update incoming payment", "description": { "content": "Full replacement of an existing incoming payment. The `If-Match` header is accepted for API symmetry but is not enforced (Cobro has no OPTLOCK).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "incoming-payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Incoming payment ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check. (accepted for symmetry; Cobro has no OPTLOCK)", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "dcf16301-7bab-4456-b473-8822e37920e3", "name": "Incoming payment updated", "originalRequest": { "url": { "path": [ "api", "v2", "incoming-payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Incoming payment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check. (accepted for symmetry; Cobro has no OPTLOCK)", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"RI\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bd382e43-010b-4889-b18f-477c02316bd3", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "incoming-payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Incoming payment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check. (accepted for symmetry; Cobro has no OPTLOCK)", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ffebc939-026a-4edc-9fb7-b2e8305cb127", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "incoming-payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Incoming payment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check. (accepted for symmetry; Cobro has no OPTLOCK)", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "de97a53d-cfaf-4007-b226-1a884465b9b6", "name": "Authenticated user is missing the `EDITAR_COBROS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "incoming-payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Incoming payment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check. (accepted for symmetry; Cobro has no OPTLOCK)", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1a2b48f2-c539-4496-b299-56cc99d5d991", "name": "Incoming payment not found", "originalRequest": { "url": { "path": [ "api", "v2", "incoming-payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Incoming payment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check. (accepted for symmetry; Cobro has no OPTLOCK)", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8a93c515-13df-4ba0-9986-840a4f393ab2", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "incoming-payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Incoming payment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check. (accepted for symmetry; Cobro has no OPTLOCK)", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "02e54f9a-f66f-4429-84e2-8e0a675ae30c", "name": "Delete incoming payment", "request": { "name": "Delete incoming payment", "description": { "content": "Deletes an incoming payment. The `If-Match` header is accepted for API symmetry but not enforced (Cobro has no OPTLOCK).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "incoming-payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Incoming payment ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check. (accepted for symmetry; Cobro has no OPTLOCK)", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "912adf5f-e90e-4826-bfa5-e2ae197cb12a", "name": "Incoming payment deleted", "originalRequest": { "url": { "path": [ "api", "v2", "incoming-payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Incoming payment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check. (accepted for symmetry; Cobro has no OPTLOCK)", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "85a6c83a-d552-4f08-b296-d22140e1a274", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "incoming-payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Incoming payment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check. (accepted for symmetry; Cobro has no OPTLOCK)", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e98c752d-02dc-4a15-a75b-eb6284414a67", "name": "Authenticated user is missing the `BORRAR_COBROS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "incoming-payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Incoming payment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check. (accepted for symmetry; Cobro has no OPTLOCK)", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "761c0643-cc24-4b6a-a5d1-2382ba7250d3", "name": "Incoming payment not found", "originalRequest": { "url": { "path": [ "api", "v2", "incoming-payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Incoming payment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check. (accepted for symmetry; Cobro has no OPTLOCK)", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1e0438ea-1fb0-4d9f-8bf6-d278d246f8a5", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "incoming-payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Incoming payment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check. (accepted for symmetry; Cobro has no OPTLOCK)", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a60be8f7-13b6-458d-99ca-9a59b2ac7d3c", "name": "Merge-patch incoming payment", "request": { "name": "Merge-patch incoming payment", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "incoming-payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Incoming payment ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check. (accepted for symmetry; Cobro has no OPTLOCK)", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "0634b7d2-c80b-4f29-808b-e7ebd3dffc14", "name": "Incoming payment patched", "originalRequest": { "url": { "path": [ "api", "v2", "incoming-payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Incoming payment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check. (accepted for symmetry; Cobro has no OPTLOCK)", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"RI\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "474d0fa0-7356-4121-83a6-e609c2aafba8", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details. Also returned for malformed merge-patch payloads.", "originalRequest": { "url": { "path": [ "api", "v2", "incoming-payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Incoming payment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check. (accepted for symmetry; Cobro has no OPTLOCK)", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "18e18f2a-bc0f-423e-8af0-50972b44e56f", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "incoming-payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Incoming payment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check. (accepted for symmetry; Cobro has no OPTLOCK)", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bca3206e-f9ec-427a-ae27-f2d89d1f6767", "name": "Authenticated user is missing the `EDITAR_COBROS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "incoming-payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Incoming payment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check. (accepted for symmetry; Cobro has no OPTLOCK)", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7b5b90dd-dcfe-4842-847d-64534d3c719c", "name": "Incoming payment not found", "originalRequest": { "url": { "path": [ "api", "v2", "incoming-payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Incoming payment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check. (accepted for symmetry; Cobro has no OPTLOCK)", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3458b017-2f25-465a-9846-c7320d611270", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "incoming-payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Incoming payment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check. (accepted for symmetry; Cobro has no OPTLOCK)", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "47d8ebb8-7276-46f0-8d9c-010f0f1f12c5", "name": "List incoming payments", "request": { "name": "List incoming payments", "description": { "content": "Returns a paginated list of incoming payments (cobros). The constraint `issued==true` is always enforced server-side.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "incoming-payments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "87a8cd79-3d83-4c61-9c7b-f237555c3463", "name": "Page of incoming payments", "originalRequest": { "url": { "path": [ "api", "v2", "incoming-payments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7d67a01e-dc11-41e9-aee7-2abec7ed36ae", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "incoming-payments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c08e1d45-34f7-4154-b918-bb0e5ae97fb2", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "incoming-payments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "93daa956-079e-4b43-a379-7257f0b93843", "name": "Authenticated user is missing the `VER_COBROS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "incoming-payments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "287a6484-9a41-4f98-812b-edea806ebfed", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "incoming-payments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7cd6baf1-f6d4-4df7-b7f9-3dac3b4404f3", "name": "Create incoming payment", "request": { "name": "Create incoming payment", "description": { "content": "Records an incoming payment against an invoice, order, delivery note or quote. Exactly one of those parent IDs is required; `amount` must be > 0. The `issued` flag is forced to `true` server-side.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "incoming-payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "33000ea4-8fb5-4519-bc7d-630c0373e941", "name": "Incoming payment created", "originalRequest": { "url": { "path": [ "api", "v2", "incoming-payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"RI\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bb58211f-ab9e-4e70-bce3-41beab254a2c", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "incoming-payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9a0e89e9-862e-476c-ad8a-bbeedd94666f", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "incoming-payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "255d24f4-b20e-4621-9763-f494fb561a7d", "name": "Authenticated user is missing the `CREAR_COBROS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "incoming-payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5311ec14-6246-47be-9bce-de9a1aa54dd9", "name": "Referenced parent entity not found", "originalRequest": { "url": { "path": [ "api", "v2", "incoming-payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a43742ea-b620-4207-846f-0570592dd6ec", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "incoming-payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"transactionKind\": \"MC\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "groups", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "f5d593f1-1c62-4053-8e0e-9c1309e9d45e", "name": "Get group by ID", "request": { "name": "Get group by ID", "description": { "content": "Returns a single group by its primary key. The response carries a strong `ETag` header with the current version.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Group ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "eb8d05cc-7bff-4912-8336-fc48f2a0d03d", "name": "Group found", "originalRequest": { "url": { "path": [ "api", "v2", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Group ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bdfcd322-7003-4269-8fb5-a5d20893b22c", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Group ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "28f964a3-2b00-4083-a099-cbf7a1b5b822", "name": "Authenticated user is missing the `VER_GRUPOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Group ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "417c555c-cf2f-44b7-bc7c-f742be61a911", "name": "Group not found", "originalRequest": { "url": { "path": [ "api", "v2", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Group ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b1a777f7-1924-473c-a076-665fbec2467b", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Group ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b59a903b-4543-4437-bb61-ade9dcbc0150", "name": "Update group", "request": { "name": "Update group", "description": { "content": "Full replacement of an existing group. Send the `If-Match` header with the current ETag for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Group ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "c5af50ad-2f3e-4f22-877e-b86ce07b1b63", "name": "Group updated", "originalRequest": { "url": { "path": [ "api", "v2", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Group ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "800f5c9d-f9c7-4bbc-b1ad-f5ff44b93928", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Group ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ab509f44-2180-4efd-98f6-8fe70df32301", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Group ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c4708b85-23ce-4242-812e-bb74de788183", "name": "Authenticated user is missing the `EDITAR_GRUPOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Group ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cab6046f-e6ed-4803-a663-1f5ffe824b9e", "name": "Group not found", "originalRequest": { "url": { "path": [ "api", "v2", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Group ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2f2b9bbd-0e5d-4422-bd73-8c11056f8854", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Group ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "757fc916-cc38-4e55-b60d-2d0e90b89529", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Group ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b78513ec-52a3-44f3-b9d8-2da29378913c", "name": "Delete group", "request": { "name": "Delete group", "description": { "content": "Deletes a group. Send the `If-Match` header with the current ETag for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Group ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "897a1929-cc60-414e-b2df-28629d15458e", "name": "Group deleted", "originalRequest": { "url": { "path": [ "api", "v2", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Group ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1f7c49e5-794e-45c4-9c28-931b45a54a1b", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Group ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ef51de58-3614-4967-a333-cd229502522d", "name": "Authenticated user is missing the `BORRAR_GRUPOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Group ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "eee763c3-b194-4771-9d12-effe4fb8a4a7", "name": "Group not found", "originalRequest": { "url": { "path": [ "api", "v2", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Group ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "728568c1-7cb0-4166-a500-e7c08cbf8168", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Group ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "674700b1-45a3-4d4f-a40d-4f1b40e70de7", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Group ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2937efac-51f8-42f0-8822-797e7d950569", "name": "Merge-patch group", "request": { "name": "Merge-patch group", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Group ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "3b2dd091-5c32-452b-8fdb-0cd6af76c50f", "name": "Group patched", "originalRequest": { "url": { "path": [ "api", "v2", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Group ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3d1ebdbd-4d95-43d7-88ba-06c4549aed8e", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details. Also returned for malformed merge-patch payloads.", "originalRequest": { "url": { "path": [ "api", "v2", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Group ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e2411afb-beae-4587-a802-1cc56b0ba757", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Group ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ced3961f-262d-4f8f-b1e5-40cab20c9aeb", "name": "Authenticated user is missing the `EDITAR_GRUPOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Group ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4251bf17-4233-49c7-b9ee-11ba5d12187d", "name": "Group not found", "originalRequest": { "url": { "path": [ "api", "v2", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Group ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c9ad20b0-3dd2-41b8-81b6-783fb5a3242d", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Group ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9cc61e5a-9ccb-4b37-91b2-501516b9b8c4", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Group ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "78fba2cf-30df-4ed2-a2e3-d69e177e4d62", "name": "List groups", "request": { "name": "List groups", "description": { "content": "Returns a paginated list of groups with envelope `{data, totalCount, skip, limit, hasMore}`. Default sort is `name:asc`. Limit is capped at 200; skip is clamped to >= 0.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "fb11fdba-bd46-4fd0-a55e-9664543dc45a", "name": "Page of groups", "originalRequest": { "url": { "path": [ "api", "v2", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6139f823-aa5f-478f-883d-7de4ab2a8a8b", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "58284c1b-eb0e-49b0-9a1e-9aab8a892bdf", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "85965eab-ece7-44da-bfe6-0283f9820b21", "name": "Authenticated user is missing the `VER_GRUPOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d3013f40-da48-44dc-8d7a-4f989931ebf6", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bbb4c56d-3617-48e0-ba5c-29604068e87a", "name": "Create group", "request": { "name": "Create group", "description": { "content": "Creates a new group. Business logic runs in the legacy WAR via the internal commands gateway.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "fa7eec7c-f19c-43aa-bd62-c23de9252114", "name": "Group created", "originalRequest": { "url": { "path": [ "api", "v2", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7530592d-dd3b-4911-b26b-b26ecb9ec315", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e7ea4dd3-5dfb-4a35-a49e-fe386090b1a6", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "49842cc7-ac40-4e14-9a98-1653f9629c5e", "name": "Authenticated user is missing the `CREAR_GRUPOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "18eba38f-6030-4a66-a8b9-596e0fa652e4", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "new", "description": "", "item": [ { "id": "6f38c595-1d09-496e-8d25-a58c4294185a", "name": "Prototype group for a creation form", "request": { "name": "Prototype group for a creation form", "description": { "content": "Returns a non-persisted group pre-populated with backend defaults. Optional hints include `companyId` and `copyFromId`. The response has no `id`, `version` or audit fields; call `POST /api/v2/groups` afterwards to persist it.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "groups", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "345765f1-f73b-438c-8861-c9e1f114aa62", "name": "Group prototype with defaults", "originalRequest": { "url": { "path": [ "api", "v2", "groups", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "584e2e6f-9742-4dbc-9ccf-3389697a947d", "name": "Invalid prepare-create hints", "originalRequest": { "url": { "path": [ "api", "v2", "groups", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "aeb7cedb-4dab-4204-b4ad-c361329f82fa", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "groups", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1848eb4a-e0fd-49fc-a308-a5fd42b48c04", "name": "Authenticated user is missing the `CREAR_GRUPOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "groups", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5ec763cb-ee57-4f62-a64f-95b0bdcfaded", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "groups", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "equivalence-surcharge-types", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "d6215cd1-1eac-4ab5-9ea7-dc2809d066c0", "name": "Get equivalence surcharge type by ID", "request": { "name": "Get equivalence surcharge type by ID", "description": { "content": "Returns the equivalence surcharge type including associatedAccounts.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "equivalence-surcharge-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Equivalence surcharge type ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "f56031a9-5fe9-4913-9e3d-876c72375f0c", "name": "Equivalence surcharge type found", "originalRequest": { "url": { "path": [ "api", "v2", "equivalence-surcharge-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Equivalence surcharge type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"surchargeRate\": \"\",\n \"associatedAccounts\": [\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n },\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9d9b656b-40a1-46ed-add7-3a711fae2810", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "equivalence-surcharge-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Equivalence surcharge type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8a29f159-8662-47c1-b432-5840664b30ac", "name": "Authenticated user is missing the `VER_TIPOSRE` permission", "originalRequest": { "url": { "path": [ "api", "v2", "equivalence-surcharge-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Equivalence surcharge type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5dbb1568-67c0-4da4-bfb8-3ff7780d03fd", "name": "Equivalence surcharge type not found", "originalRequest": { "url": { "path": [ "api", "v2", "equivalence-surcharge-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Equivalence surcharge type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "12ff4fd6-6d1f-435f-9d9b-939052f4a970", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "equivalence-surcharge-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Equivalence surcharge type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "99faf9b5-7df2-422b-9e0f-4022fbd9546e", "name": "Update equivalence surcharge type", "request": { "name": "Update equivalence surcharge type", "description": { "content": "Full replacement. On update, null associatedAccounts leaves existing children untouched; [] clears; non-empty list replaces.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "equivalence-surcharge-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Equivalence surcharge type ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"surchargeRate\": \"\",\n \"associatedAccounts\": [\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n },\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "ab6b5c46-a2a2-499a-8e6b-81063255056a", "name": "Equivalence surcharge type updated", "originalRequest": { "url": { "path": [ "api", "v2", "equivalence-surcharge-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Equivalence surcharge type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"surchargeRate\": \"\",\n \"associatedAccounts\": [\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n },\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"surchargeRate\": \"\",\n \"associatedAccounts\": [\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n },\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "24140490-8b9b-453d-884d-045d92907e31", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "equivalence-surcharge-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Equivalence surcharge type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"surchargeRate\": \"\",\n \"associatedAccounts\": [\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n },\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c6eb1b2a-30e1-47e4-ae82-cfdbad2cc317", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "equivalence-surcharge-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Equivalence surcharge type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"surchargeRate\": \"\",\n \"associatedAccounts\": [\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n },\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "426e39df-cedc-4b5a-b1bd-6bf99d72cc99", "name": "Authenticated user is missing the `EDITAR_TIPOSRE` permission", "originalRequest": { "url": { "path": [ "api", "v2", "equivalence-surcharge-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Equivalence surcharge type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"surchargeRate\": \"\",\n \"associatedAccounts\": [\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n },\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "89d6f728-1863-4dd8-8ed6-e0c7f35c54c1", "name": "Equivalence surcharge type not found", "originalRequest": { "url": { "path": [ "api", "v2", "equivalence-surcharge-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Equivalence surcharge type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"surchargeRate\": \"\",\n \"associatedAccounts\": [\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n },\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ff64140e-9ad9-4020-be2a-dda77cb9d6f6", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "equivalence-surcharge-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Equivalence surcharge type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"surchargeRate\": \"\",\n \"associatedAccounts\": [\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n },\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f9eef20d-cc21-4a44-b32c-87fd68d0d571", "name": "Delete equivalence surcharge type", "request": { "name": "Delete equivalence surcharge type", "description": { "content": "Deletes the equivalence surcharge type. If-Match is accepted but ignored (TipoRE is not versioned).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "equivalence-surcharge-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Equivalence surcharge type ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "97509313-e95f-49c1-8701-7321f075bab1", "name": "Equivalence surcharge type deleted", "originalRequest": { "url": { "path": [ "api", "v2", "equivalence-surcharge-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Equivalence surcharge type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "35849430-4af7-4f80-a912-dcdf1faf56b4", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "equivalence-surcharge-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Equivalence surcharge type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b4d8132d-3329-4ffb-ac07-a49ce212004b", "name": "Authenticated user is missing the `BORRAR_TIPOSRE` permission", "originalRequest": { "url": { "path": [ "api", "v2", "equivalence-surcharge-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Equivalence surcharge type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2b66c960-ad2d-4f13-bc3d-c4dc180cb2cf", "name": "Equivalence surcharge type not found", "originalRequest": { "url": { "path": [ "api", "v2", "equivalence-surcharge-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Equivalence surcharge type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "402511af-65ab-44d5-bcdd-54d4ce2ed900", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "equivalence-surcharge-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Equivalence surcharge type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cb6331cf-d5ee-4901-95cf-f3c88dfa4ced", "name": "Merge-patch equivalence surcharge type", "request": { "name": "Merge-patch equivalence surcharge type", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "equivalence-surcharge-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Equivalence surcharge type ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "16536fc9-bd95-47ee-b2b3-1bf1fd63474d", "name": "Equivalence surcharge type patched", "originalRequest": { "url": { "path": [ "api", "v2", "equivalence-surcharge-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Equivalence surcharge type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"surchargeRate\": \"\",\n \"associatedAccounts\": [\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n },\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "341defaf-ebba-4940-ad77-5771a897dbdc", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details. Also returned for malformed merge-patch payloads.", "originalRequest": { "url": { "path": [ "api", "v2", "equivalence-surcharge-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Equivalence surcharge type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "87c10bc3-ccc1-4e4f-82a4-2bc4db93320e", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "equivalence-surcharge-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Equivalence surcharge type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "16fef75a-dfa1-4f1a-b1c0-8098422340ef", "name": "Authenticated user is missing the `EDITAR_TIPOSRE` permission", "originalRequest": { "url": { "path": [ "api", "v2", "equivalence-surcharge-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Equivalence surcharge type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7e226109-1137-45a7-90b6-bc656603709d", "name": "Equivalence surcharge type not found", "originalRequest": { "url": { "path": [ "api", "v2", "equivalence-surcharge-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Equivalence surcharge type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "17820081-7ef6-455a-9b9c-46538ede6e9a", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "equivalence-surcharge-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Equivalence surcharge type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "9e7ce4db-1007-4a35-bba9-9cd23da7ed3d", "name": "List equivalence surcharge types", "request": { "name": "List equivalence surcharge types", "description": { "content": "Paginated list with optional RSQL filter and sort (default lastModifiedAt:desc). Child collections are omitted; use GET /{id} for associatedAccounts.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "equivalence-surcharge-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "5122093b-9ed5-4835-8eb6-f08f02ca8e97", "name": "Page of equivalence surcharge types", "originalRequest": { "url": { "path": [ "api", "v2", "equivalence-surcharge-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1cebffea-a822-4888-8aab-cc0526676579", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "equivalence-surcharge-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ebec30a2-29fb-4fff-8639-e75ba49bccd7", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "equivalence-surcharge-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2dfda26f-b69b-41db-bc99-f02a65106095", "name": "Authenticated user is missing the `VER_TIPOSRE` permission", "originalRequest": { "url": { "path": [ "api", "v2", "equivalence-surcharge-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "45f89228-7494-4669-ba7a-08caeb94b976", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "equivalence-surcharge-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "492f6a02-cdd5-4ca3-bb4f-3cdfab246ba8", "name": "Create equivalence surcharge type", "request": { "name": "Create equivalence surcharge type", "description": { "content": "Persists via the internal commands gateway. associatedAccounts: null leaves empty; [] clears; list replaces.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "equivalence-surcharge-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"surchargeRate\": \"\",\n \"associatedAccounts\": [\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n },\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "285a6792-715d-4890-a6de-a1aad451e6b9", "name": "Equivalence surcharge type created", "originalRequest": { "url": { "path": [ "api", "v2", "equivalence-surcharge-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"surchargeRate\": \"\",\n \"associatedAccounts\": [\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n },\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"surchargeRate\": \"\",\n \"associatedAccounts\": [\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n },\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d059fc10-b523-4b54-aad4-44312476def0", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "equivalence-surcharge-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"surchargeRate\": \"\",\n \"associatedAccounts\": [\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n },\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bb6d6732-f260-433f-ab17-39cb3edd1998", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "equivalence-surcharge-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"surchargeRate\": \"\",\n \"associatedAccounts\": [\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n },\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8dfd7384-7608-49b1-b4b8-d2e260b93f2e", "name": "Authenticated user is missing the `CREAR_TIPOSRE` permission", "originalRequest": { "url": { "path": [ "api", "v2", "equivalence-surcharge-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"surchargeRate\": \"\",\n \"associatedAccounts\": [\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n },\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9be52d69-e0f2-4919-bc6c-f2ffa37e1eea", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "equivalence-surcharge-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"surchargeRate\": \"\",\n \"associatedAccounts\": [\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n },\n {\n \"companyId\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "new", "description": "", "item": [ { "id": "1bc63742-e6d0-4233-9890-f9ba16b98212", "name": "Prototype an equivalence surcharge type for a creation form", "request": { "name": "Prototype an equivalence surcharge type for a creation form", "description": { "content": "Non-persisted defaults: current company, enabled=true. Optional JSON hints: companyId, copyFromId.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "equivalence-surcharge-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "b0e5ec33-1c74-4876-88f2-29c7b8a4e405", "name": "Equivalence surcharge type prototype", "originalRequest": { "url": { "path": [ "api", "v2", "equivalence-surcharge-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"surchargeRate\": \"\",\n \"associatedAccounts\": [\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n },\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9b51d881-3ee2-4f0c-b312-2efd172480bf", "name": "Hint references an unknown entity", "originalRequest": { "url": { "path": [ "api", "v2", "equivalence-surcharge-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "55b6b2c0-bba8-4eb1-b6d1-949c8f1a9349", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "equivalence-surcharge-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9b68aa08-2e78-403a-9ecb-e789057239c3", "name": "Authenticated user is missing the `CREAR_TIPOSRE` permission", "originalRequest": { "url": { "path": [ "api", "v2", "equivalence-surcharge-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7aad348a-2016-41bc-8248-26826a4d6c62", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "equivalence-surcharge-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "employee-positions", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "8d6a53ca-370b-475a-997b-c49cdef74ba9", "name": "Get employee position by ID", "request": { "name": "Get employee position by ID", "description": { "content": "Returns a single employee store position by its primary key.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "employee-positions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Employee position ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "a279a419-d4f3-4e6d-a79b-e6f58b354b20", "name": "Employee position found", "originalRequest": { "url": { "path": [ "api", "v2", "employee-positions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Employee position ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"commissionsEnabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d3151cc4-f2a6-4c60-9684-16b024399642", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "employee-positions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Employee position ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4698adc0-0d11-48d2-9817-8223a5380494", "name": "Authenticated user is missing the `VER_POSICIONEMPLEADOTIENDA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "employee-positions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Employee position ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "df0bfc45-da94-423e-87d1-1cab00b13c33", "name": "Employee position not found", "originalRequest": { "url": { "path": [ "api", "v2", "employee-positions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Employee position ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9c56321d-bfe2-4bbb-ab0c-b7a4849435ac", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "employee-positions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Employee position ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8530e3cc-de53-41b0-a78c-8052dc004c3b", "name": "Update employee position", "request": { "name": "Update employee position", "description": { "content": "Full replacement of an existing employee store position.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "employee-positions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Employee position ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"commissionsEnabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "25a236c2-e928-4b95-ac95-dfddcbcf2a63", "name": "Employee position updated", "originalRequest": { "url": { "path": [ "api", "v2", "employee-positions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Employee position ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"commissionsEnabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"commissionsEnabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b2c56072-e8d0-4ba0-a787-fdab2ddf2150", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "employee-positions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Employee position ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"commissionsEnabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "458469a1-fcdc-41d7-8e3a-a1d7967d4802", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "employee-positions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Employee position ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"commissionsEnabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f6a1fd49-1fa8-42f7-b6fd-0f01e9131325", "name": "Authenticated user is missing the `EDITAR_POSICIONEMPLEADOTIENDA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "employee-positions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Employee position ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"commissionsEnabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b9a8bbd3-de22-41e2-bfe3-15e24cc2fe1d", "name": "Employee position not found", "originalRequest": { "url": { "path": [ "api", "v2", "employee-positions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Employee position ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"commissionsEnabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "addfff26-9015-4ed7-8206-f173bfde53c7", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "employee-positions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Employee position ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"commissionsEnabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bba1e191-7a0e-434b-81e7-9cfa390daaf9", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "employee-positions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Employee position ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"commissionsEnabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c033b571-0235-42a9-ac15-2a518b1d5324", "name": "Delete employee position", "request": { "name": "Delete employee position", "description": { "content": "Deletes an employee store position.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "employee-positions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Employee position ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "04de459c-367a-42a7-b28b-cc574912783b", "name": "Employee position deleted", "originalRequest": { "url": { "path": [ "api", "v2", "employee-positions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Employee position ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "951194f0-f831-4cf9-96a6-a5063c6e13d7", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "employee-positions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Employee position ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "308e22f7-81c7-48e9-a8dc-0d61531f5583", "name": "Authenticated user is missing the `BORRAR_POSICIONEMPLEADOTIENDA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "employee-positions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Employee position ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6d3cb0f3-a50e-4c4f-8b31-62815d8f95c2", "name": "Employee position not found", "originalRequest": { "url": { "path": [ "api", "v2", "employee-positions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Employee position ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "df6d8670-a7d9-484f-a587-20b309c9904e", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "employee-positions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Employee position ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f1f9fc94-5c57-4bcc-9290-941ca5df6a25", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "employee-positions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Employee position ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9d8c5531-8acd-4903-ba38-52a1703c7bad", "name": "Merge-patch employee position", "request": { "name": "Merge-patch employee position", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "employee-positions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Employee position ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "2fa5d346-6c34-4a67-9f18-589fc0752def", "name": "Employee position patched", "originalRequest": { "url": { "path": [ "api", "v2", "employee-positions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Employee position ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"commissionsEnabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9739cabc-d19c-4128-a61d-f020b9856994", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details. Also returned for malformed merge-patch payloads.", "originalRequest": { "url": { "path": [ "api", "v2", "employee-positions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Employee position ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "afe687ae-7b90-46c1-a678-324e520cd441", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "employee-positions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Employee position ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fdf99e28-a2b0-4c5b-b40d-bc8f4b2bdfda", "name": "Authenticated user is missing the `EDITAR_POSICIONEMPLEADOTIENDA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "employee-positions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Employee position ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1d7f97f8-a723-4750-86a1-2a73828c77df", "name": "Employee position not found", "originalRequest": { "url": { "path": [ "api", "v2", "employee-positions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Employee position ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "47e30e7c-4277-47ae-8fbf-2d707f31bdff", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "employee-positions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Employee position ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cec65120-40bd-4530-88b0-a1c0057c2453", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "employee-positions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Employee position ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "a50c3b9a-1460-4eaa-818a-d26392506436", "name": "List employee positions", "request": { "name": "List employee positions", "description": { "content": "Returns a paginated list of employee store positions with envelope `{data, totalCount, skip, limit, hasMore}`. Default sort is `name:asc`. Limit is capped at 200; skip is clamped to >= 0.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "employee-positions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "f8926d2c-7b29-4c8e-9126-fd8ac5455484", "name": "Page of employee positions", "originalRequest": { "url": { "path": [ "api", "v2", "employee-positions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "48da2ca8-e9ed-4740-b2c2-9b1980b17a70", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "employee-positions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8eb7001e-9fbd-493e-b294-94766b68e850", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "employee-positions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "dab199d1-0a85-4474-a101-e593f25a98ba", "name": "Authenticated user is missing the `VER_POSICIONEMPLEADOTIENDA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "employee-positions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5c28032e-8e69-4e96-8dee-3dfc0d7c6a9e", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "employee-positions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b7c5a174-9ecf-4279-a6ff-d5a92165fb36", "name": "Create employee position", "request": { "name": "Create employee position", "description": { "content": "Creates a new employee store position. Business logic runs in the legacy WAR via the internal commands gateway.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "employee-positions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"commissionsEnabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "5914779c-4748-4c68-bb38-599c127eb74f", "name": "Employee position created", "originalRequest": { "url": { "path": [ "api", "v2", "employee-positions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"commissionsEnabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"commissionsEnabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bc77c64d-346d-4708-ad8f-738aeaa094d5", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "employee-positions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"commissionsEnabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0e846b19-5055-4187-b8bd-2db3e1f480e7", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "employee-positions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"commissionsEnabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5f73d87e-3ab9-44e7-8d14-7cd31e876762", "name": "Authenticated user is missing the `CREAR_POSICIONEMPLEADOTIENDA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "employee-positions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"commissionsEnabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "477744b9-33f4-4de1-aae8-b7e231ef74e6", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "employee-positions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"commissionsEnabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cdfd19ad-5951-4d02-a96e-c319c7f96569", "name": "Bulk delete employee positions", "request": { "name": "Bulk delete employee positions", "description": { "content": "Removes every id in `ids` as a single all-or-nothing transaction. If any id is missing or outside the user's company scope the whole operation is rolled back. There is no `If-Match` header on this endpoint.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "employee-positions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "ab61573a-a08b-44e6-8b45-5a834d506383", "name": "All entities deleted", "originalRequest": { "url": { "path": [ "api", "v2", "employee-positions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"deleted\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "14d2883b-b73f-4a2c-8370-7120ce0a8413", "name": "Empty `ids`, malformed payload, or unknown id", "originalRequest": { "url": { "path": [ "api", "v2", "employee-positions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "27740818-f24c-47dd-bbc8-8925ee4c3ab8", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "employee-positions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "77c25e32-b5f1-4740-a8b2-ed25aff757cd", "name": "Authenticated user is missing the `BORRAR_POSICIONEMPLEADOTIENDA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "employee-positions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "06841f89-d62d-4f91-b64f-e322b55de9ac", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "employee-positions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4628e461-2fe5-4eea-b1fa-412d400290de", "name": "Bulk patch employee positions", "request": { "name": "Bulk patch employee positions", "description": { "content": "Applies the same `patch` to every id in `ids` as a single all-or-nothing transaction. Editable fields are restricted to a whitelist (`enabled`, `blockType`, `description`, `commissionsEnabled`, identity (`code`, `name`), multi-tenant scope (`companyId`) and audit fields are rejected. If any id is missing or outside the user's company scope the whole operation is rolled back.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "employee-positions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"patch\": {\n \"key_0\": \"string\",\n \"key_1\": 4074,\n \"key_2\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "446fa810-84db-46df-a1e7-0979899de7a0", "name": "All entities updated", "originalRequest": { "url": { "path": [ "api", "v2", "employee-positions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"patch\": {\n \"key_0\": \"string\",\n \"key_1\": 4074,\n \"key_2\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"updated\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2f6ab686-0d05-402d-ba8e-f88cf54dcbbb", "name": "Empty `ids`/`patch`, malformed payload, non-whitelisted field or unknown id", "originalRequest": { "url": { "path": [ "api", "v2", "employee-positions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"patch\": {\n \"key_0\": \"string\",\n \"key_1\": 4074,\n \"key_2\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3c9ae290-ab58-4422-b11e-f223d64fcd00", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "employee-positions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"patch\": {\n \"key_0\": \"string\",\n \"key_1\": 4074,\n \"key_2\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ffe7648a-7ff9-469f-b1b4-242414fdbdf1", "name": "Authenticated user is missing the `EDITAR_POSICIONEMPLEADOTIENDA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "employee-positions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"patch\": {\n \"key_0\": \"string\",\n \"key_1\": 4074,\n \"key_2\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4fa063a5-d2ee-4776-a9c1-e2ae6353f57d", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "employee-positions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"patch\": {\n \"key_0\": \"string\",\n \"key_1\": 4074,\n \"key_2\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "new", "description": "", "item": [ { "id": "a8589f7c-0494-4beb-8a78-fa5401551260", "name": "Prototype employee position for a creation form", "request": { "name": "Prototype employee position for a creation form", "description": { "content": "Returns a non-persisted employee position pre-populated with backend defaults (current company, next numeric `code`, `enabled=true`). Optional hints: `companyId`, `copyFromId`. Call `POST /api/v2/employee-positions` afterwards to persist.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "employee-positions", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "94e520e8-39a4-451b-ad2d-4f01f41731ef", "name": "Employee position prototype with defaults", "originalRequest": { "url": { "path": [ "api", "v2", "employee-positions", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"commissionsEnabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2f1c249b-042c-4568-bd86-f17181ecd4e6", "name": "Invalid prepare-create hints", "originalRequest": { "url": { "path": [ "api", "v2", "employee-positions", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "208adbc9-a1ce-4f4e-972c-77ef6dc5a3f3", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "employee-positions", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ee06f9ce-6816-4a98-89f3-a5ff5a441290", "name": "Authenticated user is missing the `CREAR_POSICIONEMPLEADOTIENDA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "employee-positions", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9f467268-5712-4c4b-a794-ae404e767863", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "employee-positions", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "document-statuses", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "cc43131c-8372-4748-ae2e-b3a80037f724", "name": "Get document status by ID", "request": { "name": "Get document status by ID", "description": { "content": "Returns a single custom document status by its primary key.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "document-statuses", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Document status ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "b25e776e-0a2b-4512-bfdb-69a79733ae04", "name": "Document status found", "originalRequest": { "url": { "path": [ "api", "v2", "document-statuses", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Document status ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"documentKind\": \"\",\n \"statusType\": \"\",\n \"colorHex\": \"\",\n \"enabled\": \"\",\n \"communicationId\": \"\",\n \"communicationName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"lastActionSystem\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "287f6eb1-4a34-4f6a-bf90-c7fe085c2b59", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "document-statuses", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Document status ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5b2d96c8-80d6-45f1-97cb-ed1c56e18793", "name": "Authenticated user is missing the `VER_ESTADOSDOCUMENTO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "document-statuses", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Document status ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "749a4d18-b1ff-4ae7-90d4-7490c1510c77", "name": "Document status not found", "originalRequest": { "url": { "path": [ "api", "v2", "document-statuses", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Document status ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4796ecb5-94f0-4234-aa7c-71e24c82aab9", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "document-statuses", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Document status ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3248785b-8dc8-44e1-a9cc-38a599de0fc0", "name": "Update document status", "request": { "name": "Update document status", "description": { "content": "Full replacement of an existing custom document status. Send the `If-Match` header for optimistic concurrency (accepted but ignored ÔÇö not versioned).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "document-statuses", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Document status ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"documentKind\": \"\",\n \"statusType\": \"\",\n \"colorHex\": \"\",\n \"enabled\": \"\",\n \"communicationId\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "c551feed-bdeb-45cc-bed0-1df6067a0c2e", "name": "Document status updated", "originalRequest": { "url": { "path": [ "api", "v2", "document-statuses", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Document status ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"documentKind\": \"\",\n \"statusType\": \"\",\n \"colorHex\": \"\",\n \"enabled\": \"\",\n \"communicationId\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"documentKind\": \"\",\n \"statusType\": \"\",\n \"colorHex\": \"\",\n \"enabled\": \"\",\n \"communicationId\": \"\",\n \"communicationName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"lastActionSystem\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bdc5e047-13f1-453d-a06a-aa4eab09ac75", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "document-statuses", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Document status ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"documentKind\": \"\",\n \"statusType\": \"\",\n \"colorHex\": \"\",\n \"enabled\": \"\",\n \"communicationId\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "aa15fcf6-0b3c-4de4-b85f-840d55a42126", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "document-statuses", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Document status ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"documentKind\": \"\",\n \"statusType\": \"\",\n \"colorHex\": \"\",\n \"enabled\": \"\",\n \"communicationId\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ceb97054-72ac-47b3-8c1a-57d0e26762ec", "name": "Authenticated user is missing the `EDITAR_ESTADOSDOCUMENTO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "document-statuses", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Document status ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"documentKind\": \"\",\n \"statusType\": \"\",\n \"colorHex\": \"\",\n \"enabled\": \"\",\n \"communicationId\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6223dd36-206e-4267-a8e2-88b5c4e0b0b8", "name": "Document status not found", "originalRequest": { "url": { "path": [ "api", "v2", "document-statuses", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Document status ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"documentKind\": \"\",\n \"statusType\": \"\",\n \"colorHex\": \"\",\n \"enabled\": \"\",\n \"communicationId\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ac5d526d-29f3-4803-b7bd-e3eba7b1a601", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "document-statuses", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Document status ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"documentKind\": \"\",\n \"statusType\": \"\",\n \"colorHex\": \"\",\n \"enabled\": \"\",\n \"communicationId\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4eed46f2-69ff-4f1e-b281-badde6c86377", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "document-statuses", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Document status ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"documentKind\": \"\",\n \"statusType\": \"\",\n \"colorHex\": \"\",\n \"enabled\": \"\",\n \"communicationId\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f3f1cf3b-bca9-449a-8b80-d17672ca7dd9", "name": "Delete document status", "request": { "name": "Delete document status", "description": { "content": "Deletes a custom document status. Send the `If-Match` header with the current ETag (accepted but ignored ÔÇö not versioned).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "document-statuses", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Document status ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "044c4246-2b47-4052-b873-8ceffa2f5719", "name": "Document status deleted", "originalRequest": { "url": { "path": [ "api", "v2", "document-statuses", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Document status ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "55a3ea57-4dee-4cc1-9805-531180297fa7", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "document-statuses", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Document status ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d45ec834-945c-4eb1-b19e-890a9e327a90", "name": "Authenticated user is missing the `BORRAR_ESTADOSDOCUMENTO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "document-statuses", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Document status ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d8158a83-2d41-475e-925a-806b375e5aa3", "name": "Document status not found", "originalRequest": { "url": { "path": [ "api", "v2", "document-statuses", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Document status ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "db7270b5-9bae-4db2-9247-4b454e5f41a0", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "document-statuses", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Document status ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "31ac6948-c836-4a5f-9cd8-2783ff6b0c8d", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "document-statuses", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Document status ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0450a3cd-acd3-4f29-923e-69e17b7ee290", "name": "Merge-patch document status", "request": { "name": "Merge-patch document status", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "document-statuses", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Document status ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "9025bb84-d069-43c3-920f-0ca6a6240c25", "name": "Document status patched", "originalRequest": { "url": { "path": [ "api", "v2", "document-statuses", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Document status ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"documentKind\": \"\",\n \"statusType\": \"\",\n \"colorHex\": \"\",\n \"enabled\": \"\",\n \"communicationId\": \"\",\n \"communicationName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"lastActionSystem\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "731b4f43-b7cf-4144-beae-64827bc98fba", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details. Also returned for malformed merge-patch payloads.", "originalRequest": { "url": { "path": [ "api", "v2", "document-statuses", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Document status ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0c1c52d2-6009-4d06-aeb5-268f29470c4a", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "document-statuses", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Document status ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "55626783-2112-475e-84e4-7b5ad7bb7aa7", "name": "Authenticated user is missing the `EDITAR_ESTADOSDOCUMENTO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "document-statuses", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Document status ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4c9461e2-4153-4791-a8c8-a5411a782d4f", "name": "Document status not found", "originalRequest": { "url": { "path": [ "api", "v2", "document-statuses", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Document status ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e557802f-ec38-45fc-a34f-357ed250169b", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "document-statuses", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Document status ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "643ca69b-8710-45e3-b6b2-33396bff1a34", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "document-statuses", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Document status ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "aa2b5026-ab5d-4366-a5f1-bc3a24b1b649", "name": "List document statuses", "request": { "name": "List document statuses", "description": { "content": "Returns a paginated list of custom document statuses with envelope `{data, totalCount, skip, limit, hasMore}`. Supports optional RSQL `filter`, `sort` (default `name:asc`), `skip`/`limit` pagination and `modifiedAfter`/`modifiedBefore` bookends.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "document-statuses" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "97dcaed5-a757-4fbd-aa82-971d7dca6a7e", "name": "Page of document statuses", "originalRequest": { "url": { "path": [ "api", "v2", "document-statuses" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "96d7a2c7-a280-47aa-9e4d-734032b51c8a", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "document-statuses" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e23b24dc-3ffd-42da-b2d7-87bc5e5bbf14", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "document-statuses" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "006af3f1-fb15-4521-a218-de9ea45050ca", "name": "Authenticated user is missing the `VER_ESTADOSDOCUMENTO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "document-statuses" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "424e8578-d36f-4c89-96f9-402ba0038aab", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "document-statuses" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7644c078-ea41-4956-9cdb-d64a3b42b389", "name": "Create document status", "request": { "name": "Create document status", "description": { "content": "Creates a new custom document status. Business logic runs in the legacy WAR via the internal commands gateway.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "document-statuses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"documentKind\": \"\",\n \"statusType\": \"\",\n \"colorHex\": \"\",\n \"enabled\": \"\",\n \"communicationId\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "c341b892-ad20-4ece-afad-5c1f8999de7c", "name": "Document status created", "originalRequest": { "url": { "path": [ "api", "v2", "document-statuses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"documentKind\": \"\",\n \"statusType\": \"\",\n \"colorHex\": \"\",\n \"enabled\": \"\",\n \"communicationId\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"documentKind\": \"\",\n \"statusType\": \"\",\n \"colorHex\": \"\",\n \"enabled\": \"\",\n \"communicationId\": \"\",\n \"communicationName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"lastActionSystem\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "95e10fb8-d202-46bb-a00b-a3d6cbd6f4bb", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "document-statuses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"documentKind\": \"\",\n \"statusType\": \"\",\n \"colorHex\": \"\",\n \"enabled\": \"\",\n \"communicationId\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9b1b315a-6b10-45e2-86b2-ce08cf4cf1a3", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "document-statuses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"documentKind\": \"\",\n \"statusType\": \"\",\n \"colorHex\": \"\",\n \"enabled\": \"\",\n \"communicationId\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "43f23d53-a652-4d81-8223-4bb083bf4daa", "name": "Authenticated user is missing the `CREAR_ESTADOSDOCUMENTO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "document-statuses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"documentKind\": \"\",\n \"statusType\": \"\",\n \"colorHex\": \"\",\n \"enabled\": \"\",\n \"communicationId\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bfda291b-8213-46a3-9530-cc2190723130", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "document-statuses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"documentKind\": \"\",\n \"statusType\": \"\",\n \"colorHex\": \"\",\n \"enabled\": \"\",\n \"communicationId\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "new", "description": "", "item": [ { "id": "196e695b-8173-4a03-9fe2-d886c45b832a", "name": "Prototype document status for a creation form", "request": { "name": "Prototype document status for a creation form", "description": { "content": "Returns a non-persisted document status pre-populated with backend defaults (current company, default document family). Optional JSON hints: `companyId`, `documentKind`, `copyFromId`. The response has no `id`, `version` or audit fields; call `POST /api/v2/document-statuses` afterwards to persist.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "document-statuses", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "0e64535b-cd44-4cc6-94fb-27bd3833c660", "name": "Document status prototype with defaults", "originalRequest": { "url": { "path": [ "api", "v2", "document-statuses", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"documentKind\": \"\",\n \"statusType\": \"\",\n \"colorHex\": \"\",\n \"enabled\": \"\",\n \"communicationId\": \"\",\n \"communicationName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"lastActionSystem\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f72dfc6f-a5f0-49bb-91bf-84c5fd6d34b3", "name": "Invalid prepare-create hints", "originalRequest": { "url": { "path": [ "api", "v2", "document-statuses", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "16caa2f6-803c-46c5-9df6-b09ec4464a1f", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "document-statuses", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "da1a99bb-6584-4a4d-818f-f9234ecc9250", "name": "Authenticated user is missing the `CREAR_ESTADOSDOCUMENTO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "document-statuses", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e26d37fc-7c08-42c0-afe5-1ee2ab9f6967", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "document-statuses", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "departments", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "5f4b6d20-077f-48b8-996c-1ef53be760e6", "name": "Get department by ID", "request": { "name": "Get department by ID", "description": { "content": "Returns a single employee department by its primary key.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "departments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Department ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "a0b674da-10c7-4a5c-8b7d-26d0b0fe47f6", "name": "Department found", "originalRequest": { "url": { "path": [ "api", "v2", "departments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Department ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "74cb477e-1897-4ba6-9673-30f88667eb82", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "departments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Department ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4ff1cf81-d777-481d-a210-244e862143ba", "name": "Authenticated user is missing the `VER_DEPARTAMENTO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "departments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Department ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d3ad3aba-1571-4bc7-a39d-736690e3e645", "name": "Department not found", "originalRequest": { "url": { "path": [ "api", "v2", "departments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Department ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bd29b9c1-961b-4a65-960b-06f080b2d27f", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "departments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Department ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "715ca800-4346-4936-b500-de1c289b8bb4", "name": "Update department", "request": { "name": "Update department", "description": { "content": "Full replacement of an existing employee department.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "departments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Department ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "730f3671-802d-44b3-8fca-95a015cba7a8", "name": "Department updated", "originalRequest": { "url": { "path": [ "api", "v2", "departments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Department ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a02fa37b-e928-4e94-b0c9-26f467ebc72b", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "departments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Department ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "921fb5b3-b73c-43b3-ab82-d4004f1b2f8b", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "departments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Department ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "aba2d2eb-c6bf-4da8-bedf-05776ecead13", "name": "Authenticated user is missing the `EDITAR_DEPARTAMENTO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "departments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Department ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ecab69bf-7124-4623-89ea-da693dfe10b1", "name": "Department not found", "originalRequest": { "url": { "path": [ "api", "v2", "departments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Department ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8395942e-ac2e-404d-8c51-c9e26574593b", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "departments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Department ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "28e29a3d-bf20-4421-82a2-d31d922352e6", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "departments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Department ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cf8c7a03-be7a-4853-a3ce-dafb07e5d116", "name": "Delete department", "request": { "name": "Delete department", "description": { "content": "Deletes an employee department.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "departments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Department ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "f6651829-7234-471c-b6ae-69961f952e75", "name": "Department deleted", "originalRequest": { "url": { "path": [ "api", "v2", "departments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Department ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "676d9043-dcf2-4bd5-8272-87453e7c31af", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "departments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Department ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "300615c4-bd87-4438-a3db-8761d5f77880", "name": "Authenticated user is missing the `BORRAR_DEPARTAMENTO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "departments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Department ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6f0a189d-ae8d-4a1e-aa3c-7502f7edcbdf", "name": "Department not found", "originalRequest": { "url": { "path": [ "api", "v2", "departments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Department ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c3d1744b-bc12-42b8-8627-cce64bdb275c", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "departments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Department ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "863c67e4-a2b2-4ebc-8b0f-3ce556cf3a98", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "departments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Department ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5d68c40d-74d2-4649-b57a-e2b10bbfb3ed", "name": "Merge-patch department", "request": { "name": "Merge-patch department", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "departments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Department ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "48e3e9b1-69fb-4ca9-a42d-0edec1c1fdc2", "name": "Department patched", "originalRequest": { "url": { "path": [ "api", "v2", "departments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Department ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "403effe9-0059-42f6-b4ce-4d0d9aa3e344", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details. Also returned for malformed merge-patch payloads.", "originalRequest": { "url": { "path": [ "api", "v2", "departments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Department ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0afdbda9-3f8b-47fc-9231-298cd1304864", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "departments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Department ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "65c8388c-0530-4e5e-b69b-202c28260e7c", "name": "Authenticated user is missing the `EDITAR_DEPARTAMENTO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "departments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Department ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6df2e1e6-501c-4678-8702-ecb55c7f8962", "name": "Department not found", "originalRequest": { "url": { "path": [ "api", "v2", "departments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Department ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "10903fc1-ecba-4e69-86b0-7c08c5ed107a", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "departments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Department ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "de86ebb4-1b74-4c52-aa38-402054550664", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "departments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Department ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "77cb01e5-0737-44fe-ae55-22398e62c452", "name": "List departments", "request": { "name": "List departments", "description": { "content": "Returns a paginated list of employee departments with envelope `{data, totalCount, skip, limit, hasMore}`. Default sort is `name:asc`. Limit is capped at 200; skip is clamped to >= 0.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "departments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "2ceb90af-45e3-4c83-8149-5f1439ef89e3", "name": "Page of departments", "originalRequest": { "url": { "path": [ "api", "v2", "departments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "332c8383-514e-4641-8b5a-184dfe8f95e4", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "departments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ac7bcabb-c771-4fb5-9779-d9c04ec1ba3e", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "departments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7e0a1e39-57b8-4eec-9555-c5b4b8849d25", "name": "Authenticated user is missing the `VER_DEPARTAMENTO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "departments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2c344fe0-4510-4d0f-9492-d12da714b1d0", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "departments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "70419e5d-3c05-4a0f-896e-adb0fe52b039", "name": "Create department", "request": { "name": "Create department", "description": { "content": "Creates a new employee department. Business logic runs in the legacy WAR via the internal commands gateway.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "departments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "e7eb2894-a144-4308-a613-6a0edc6509a5", "name": "Department created", "originalRequest": { "url": { "path": [ "api", "v2", "departments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d477a6ed-4f44-414a-9e29-b0adb0509a5f", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "departments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "71a788dd-09da-4bfe-8a5c-d8bed316936e", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "departments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2e59a7ec-c67a-42fd-8526-35b5c91c3441", "name": "Authenticated user is missing the `CREAR_DEPARTAMENTO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "departments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7bb153d6-c8a1-43ea-9ded-c4a28dd9d636", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "departments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3fb9a8b4-924e-4cf0-acca-5fed3588aa08", "name": "Bulk delete departments", "request": { "name": "Bulk delete departments", "description": { "content": "Removes every id in `ids` as a single all-or-nothing transaction. If any id is missing or outside the user's company scope the whole operation is rolled back. There is no `If-Match` header on this endpoint.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "departments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "9657b5bb-8462-48cc-8245-cf6cc3d018ee", "name": "All entities deleted", "originalRequest": { "url": { "path": [ "api", "v2", "departments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"deleted\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "82bdd542-34ff-4189-afaa-f333987caa3b", "name": "Empty `ids`, malformed payload, or unknown id", "originalRequest": { "url": { "path": [ "api", "v2", "departments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fb3a6b45-c47d-4433-9680-b73e39b3ae7b", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "departments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "dea897cf-3030-4dbc-8545-0c18d5666fba", "name": "Authenticated user is missing the `BORRAR_DEPARTAMENTO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "departments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7ab51271-aabc-4787-94b5-b518b74e7f6b", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "departments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a0ec9aa5-30ae-41a0-b9bd-84186cc72b40", "name": "Bulk patch departments", "request": { "name": "Bulk patch departments", "description": { "content": "Applies the same `patch` to every id in `ids` as a single all-or-nothing transaction. Editable fields are restricted to a whitelist (`enabled`, `blockType`, `description`); identity (`code`, `name`), multi-tenant scope (`companyId`) and audit fields are rejected. If any id is missing or outside the user's company scope the whole operation is rolled back.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "departments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"patch\": {\n \"key_0\": \"string\",\n \"key_1\": 4074,\n \"key_2\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "b8aa327f-73f3-4b95-95df-e94e3d4c55b3", "name": "All entities updated", "originalRequest": { "url": { "path": [ "api", "v2", "departments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"patch\": {\n \"key_0\": \"string\",\n \"key_1\": 4074,\n \"key_2\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"updated\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e03acd37-e288-4990-9fc5-beebb6265c93", "name": "Empty `ids`/`patch`, malformed payload, non-whitelisted field or unknown id", "originalRequest": { "url": { "path": [ "api", "v2", "departments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"patch\": {\n \"key_0\": \"string\",\n \"key_1\": 4074,\n \"key_2\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "48849387-7621-4345-aad2-ef3eda87e2be", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "departments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"patch\": {\n \"key_0\": \"string\",\n \"key_1\": 4074,\n \"key_2\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "db409f23-99d9-4c6e-aba9-68630d7c5a3e", "name": "Authenticated user is missing the `EDITAR_DEPARTAMENTO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "departments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"patch\": {\n \"key_0\": \"string\",\n \"key_1\": 4074,\n \"key_2\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "955adfed-6d13-47c9-a86d-d0565708551d", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "departments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"patch\": {\n \"key_0\": \"string\",\n \"key_1\": 4074,\n \"key_2\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "new", "description": "", "item": [ { "id": "78ef31d7-93ba-4640-a0c8-c44013ab21ac", "name": "Prototype department for a creation form", "request": { "name": "Prototype department for a creation form", "description": { "content": "Returns a non-persisted department pre-populated with backend defaults (current company, next numeric `code`, `enabled=true`). Optional hints: `companyId`, `copyFromId`. Call `POST /api/v2/departments` afterwards to persist.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "departments", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "9c0f3a20-160b-4a5e-a475-4be509f5e666", "name": "Department prototype with defaults", "originalRequest": { "url": { "path": [ "api", "v2", "departments", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "93fb7987-b78f-45f8-a664-ae589475525f", "name": "Invalid prepare-create hints", "originalRequest": { "url": { "path": [ "api", "v2", "departments", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "effd9bfa-080a-410e-852a-e699a166f92c", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "departments", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "86e1032b-2f1b-47ec-9bf5-ecabee5f6d3b", "name": "Authenticated user is missing the `CREAR_DEPARTAMENTO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "departments", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2e046c70-6c0e-46de-9bb4-74ca61be98b4", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "departments", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "customers", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "dc31f7e9-bac6-42c4-8cc7-56449c54b807", "name": "Get customer by ID", "request": { "name": "Get customer by ID", "description": { "content": "Returns a single customer by its primary key.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "customers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Customer ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "60dee50a-0c47-4304-bffa-df2ed58acfc7", "name": "Customer found", "originalRequest": { "url": { "path": [ "api", "v2", "customers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"isCustomer\": \"\",\n \"isSupplier\": \"\",\n \"genericCounterparty\": \"\",\n \"counterpartyType\": \"G\",\n \"checkDigit\": \"\",\n \"taxIdUnvalidated\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"businessName\": \"\",\n \"taxId\": \"\",\n \"birthDate\": \"\",\n \"gender\": \"O\",\n \"maritalStatus\": \"SOLTERO\",\n \"profession\": \"\",\n \"blockType\": \"\",\n \"leadType\": \"LEAD\",\n \"neighbour\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"mobile\": \"\",\n \"phonePrefix\": \"\",\n \"fax\": \"\",\n \"website\": \"\",\n \"contactPerson\": \"\",\n \"contactSchedule\": \"\",\n \"position\": \"\",\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"countryCode\": \"\",\n \"billingAddressId\": \"\",\n \"shippingAddressId\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"customerProfileId\": \"\",\n \"associatedCompanyId\": \"\",\n \"lastWarehouseId\": \"\",\n \"lastEmployeeId\": \"\",\n \"bank\": \"\",\n \"checkingAccount\": \"\",\n \"iban\": \"\",\n \"bic\": \"\",\n \"sepaFormat\": \"CORE\",\n \"mandateSignDate\": \"\",\n \"sepaReference\": \"\",\n \"invoiceBalance\": \"\",\n \"baseRateId\": \"\",\n \"baseRateQuota\": \"\",\n \"discountRateId\": \"\",\n \"discountRateQuota\": \"\",\n \"discountPercent\": \"\",\n \"paymentTermsId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentDay1\": \"\",\n \"paymentDay2\": \"\",\n \"vatIndicator\": \"R\",\n \"assignedEmployeeId\": \"\",\n \"excludeFromLoyaltyPoints\": \"\",\n \"disability\": \"\",\n \"allowMarketing\": \"\",\n \"allowSurveys\": \"\",\n \"sendReminders\": \"\",\n \"sendSystemNotifications\": \"\",\n \"syncCrm\": \"\",\n \"lopdConsent\": \"\",\n \"feediuId\": \"\",\n \"sourceSystem\": \"\",\n \"observations\": \"\",\n \"documentObservations\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insurerDocumentLimit\": \"\",\n \"satTaxRegime\": \"\",\n \"withholdingAgent\": \"\",\n \"withholdingPercent\": \"\",\n \"receiverActivityCode\": \"\",\n \"idDocumentType\": \"\",\n \"socialSecurity\": \"\",\n \"colombiaEpsCode\": \"\",\n \"allowOrderWithoutDocumentControl\": \"\",\n \"defaultLoyaltyWalletId\": \"\",\n \"directDebitMandateAttachmentId\": \"\",\n \"customerPhotoAttachmentId\": \"\",\n \"noahId\": \"\",\n \"contacts\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"position\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"position\": \"\"\n }\n ],\n \"addresses\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"country\": \"\",\n \"countryName\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"floor\": \"\",\n \"door\": \"\",\n \"building\": \"\",\n \"staircase\": \"\",\n \"apartment\": \"\",\n \"phone\": \"\",\n \"isBillingAddress\": \"\",\n \"isDefaultShippingAddress\": \"\"\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"country\": \"\",\n \"countryName\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"floor\": \"\",\n \"door\": \"\",\n \"building\": \"\",\n \"staircase\": \"\",\n \"apartment\": \"\",\n \"phone\": \"\",\n \"isBillingAddress\": \"\",\n \"isDefaultShippingAddress\": \"\"\n }\n ],\n \"relationships\": [\n {\n \"id\": \"\",\n \"linkedCustomerId\": \"\",\n \"linkedCustomerDisplayName\": \"\",\n \"linkedCustomerPhone\": \"\",\n \"linkedCustomerLandline\": \"\",\n \"linkedCustomerEmail\": \"\",\n \"linkedCustomerBirthDate\": \"\",\n \"linkedCustomerAge\": \"\",\n \"relationshipTypeId\": \"\",\n \"relationshipTypeName\": \"\",\n \"linkApp\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"contactSchedule\": \"\",\n \"contactPhone\": \"\",\n \"sharedLoyaltyWallets\": [\n {\n \"loyaltyWalletId\": \"\",\n \"cardNumber\": \"\",\n \"customerCode\": \"\",\n \"cardLabel\": \"\",\n \"pointsBalance\": \"\",\n \"monetaryValue\": \"\",\n \"pointsDisplay\": \"\",\n \"shared\": \"\"\n },\n {\n \"loyaltyWalletId\": \"\",\n \"cardNumber\": \"\",\n \"customerCode\": \"\",\n \"cardLabel\": \"\",\n \"pointsBalance\": \"\",\n \"monetaryValue\": \"\",\n \"pointsDisplay\": \"\",\n \"shared\": \"\"\n }\n ],\n \"sharedLoyaltyWalletCount\": \"\"\n },\n {\n \"id\": \"\",\n \"linkedCustomerId\": \"\",\n \"linkedCustomerDisplayName\": \"\",\n \"linkedCustomerPhone\": \"\",\n \"linkedCustomerLandline\": \"\",\n \"linkedCustomerEmail\": \"\",\n \"linkedCustomerBirthDate\": \"\",\n \"linkedCustomerAge\": \"\",\n \"relationshipTypeId\": \"\",\n \"relationshipTypeName\": \"\",\n \"linkApp\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"contactSchedule\": \"\",\n \"contactPhone\": \"\",\n \"sharedLoyaltyWallets\": [\n {\n \"loyaltyWalletId\": \"\",\n \"cardNumber\": \"\",\n \"customerCode\": \"\",\n \"cardLabel\": \"\",\n \"pointsBalance\": \"\",\n \"monetaryValue\": \"\",\n \"pointsDisplay\": \"\",\n \"shared\": \"\"\n },\n {\n \"loyaltyWalletId\": \"\",\n \"cardNumber\": \"\",\n \"customerCode\": \"\",\n \"cardLabel\": \"\",\n \"pointsBalance\": \"\",\n \"monetaryValue\": \"\",\n \"pointsDisplay\": \"\",\n \"shared\": \"\"\n }\n ],\n \"sharedLoyaltyWalletCount\": \"\"\n }\n ],\n \"loyaltyWallets\": [\n {\n \"id\": \"\",\n \"cardNumber\": \"\",\n \"customerCode\": \"\",\n \"cardLabel\": \"\",\n \"pointsBalance\": \"\",\n \"monetaryValue\": \"\",\n \"pointsDisplay\": \"\"\n },\n {\n \"id\": \"\",\n \"cardNumber\": \"\",\n \"customerCode\": \"\",\n \"cardLabel\": \"\",\n \"pointsBalance\": \"\",\n \"monetaryValue\": \"\",\n \"pointsDisplay\": \"\"\n }\n ],\n \"accountingAccounts\": [\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"customerAccountId\": \"\",\n \"customerAccountCode\": \"\",\n \"withholdingAccountId\": \"\",\n \"withholdingAccountCode\": \"\",\n \"creditorAccountId\": \"\",\n \"creditorAccountCode\": \"\"\n },\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"customerAccountId\": \"\",\n \"customerAccountCode\": \"\",\n \"withholdingAccountId\": \"\",\n \"withholdingAccountCode\": \"\",\n \"creditorAccountId\": \"\",\n \"creditorAccountCode\": \"\"\n }\n ],\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"valueType\": \"\",\n \"value\": \"\",\n \"optionId\": \"\",\n \"optionLabel\": \"\",\n \"optionHex\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"valueType\": \"\",\n \"value\": \"\",\n \"optionId\": \"\",\n \"optionLabel\": \"\",\n \"optionHex\": \"\"\n }\n ],\n \"sapCode\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ffde27c7-a00c-42e7-8339-f1465b64974c", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "customers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "60693e7f-02aa-4af9-88e5-fe7e20a6732a", "name": "Authenticated user is missing the `VER_CLIENTES` permission", "originalRequest": { "url": { "path": [ "api", "v2", "customers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1dc8b41f-81f0-449e-a646-660f52bd20b3", "name": "Customer not found", "originalRequest": { "url": { "path": [ "api", "v2", "customers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ac4fef35-86f7-403e-ad0d-e74bb1d6d7d0", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "customers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e73c25d4-c0d3-4bdc-9ec5-ff84b4dcdf15", "name": "Update customer", "request": { "name": "Update customer", "description": { "content": "Full replacement of an existing customer. Send the `If-Match` header with the current ETag for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "customers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Customer ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"isCustomer\": \"\",\n \"isSupplier\": \"\",\n \"genericCounterparty\": \"\",\n \"counterpartyType\": \"D\",\n \"checkDigit\": \"\",\n \"taxIdUnvalidated\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"businessName\": \"\",\n \"taxId\": \"\",\n \"birthDate\": \"\",\n \"gender\": \"H\",\n \"maritalStatus\": \"NODEFINIDO\",\n \"profession\": \"\",\n \"blockType\": \"\",\n \"leadType\": \"CL\",\n \"neighbour\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"mobile\": \"\",\n \"phonePrefix\": \"\",\n \"fax\": \"\",\n \"website\": \"\",\n \"contactPerson\": \"\",\n \"contactSchedule\": \"\",\n \"position\": \"\",\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"countryCode\": \"\",\n \"billingAddressId\": \"\",\n \"shippingAddressId\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"customerProfileId\": \"\",\n \"associatedCompanyId\": \"\",\n \"bank\": \"\",\n \"checkingAccount\": \"\",\n \"iban\": \"\",\n \"bic\": \"\",\n \"sepaFormat\": \"CORE\",\n \"mandateSignDate\": \"\",\n \"sepaReference\": \"\",\n \"baseRateId\": \"\",\n \"baseRateQuota\": \"\",\n \"discountRateId\": \"\",\n \"discountRateQuota\": \"\",\n \"discountPercent\": \"\",\n \"paymentTermsId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentDay1\": \"\",\n \"paymentDay2\": \"\",\n \"vatIndicator\": \"N\",\n \"assignedEmployeeId\": \"\",\n \"excludeFromLoyaltyPoints\": \"\",\n \"disability\": \"\",\n \"allowMarketing\": \"\",\n \"allowSurveys\": \"\",\n \"sendReminders\": \"\",\n \"sendSystemNotifications\": \"\",\n \"syncCrm\": \"\",\n \"lopdConsent\": \"\",\n \"feediuId\": \"\",\n \"sourceSystem\": \"\",\n \"observations\": \"\",\n \"documentObservations\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insurerDocumentLimit\": \"\",\n \"satTaxRegime\": \"\",\n \"withholdingAgent\": \"\",\n \"withholdingPercent\": \"\",\n \"receiverActivityCode\": \"\",\n \"idDocumentType\": \"\",\n \"socialSecurity\": \"\",\n \"colombiaEpsCode\": \"\",\n \"allowOrderWithoutDocumentControl\": \"\",\n \"defaultLoyaltyWalletId\": \"\",\n \"directDebitMandateAttachmentId\": \"\",\n \"customerPhotoAttachmentId\": \"\",\n \"noahId\": \"\",\n \"addresses\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"floor\": \"\",\n \"door\": \"\",\n \"building\": \"\",\n \"staircase\": \"\",\n \"apartment\": \"\",\n \"phone\": \"\",\n \"isBillingAddress\": \"\",\n \"isDefaultShippingAddress\": \"\"\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"floor\": \"\",\n \"door\": \"\",\n \"building\": \"\",\n \"staircase\": \"\",\n \"apartment\": \"\",\n \"phone\": \"\",\n \"isBillingAddress\": \"\",\n \"isDefaultShippingAddress\": \"\"\n }\n ],\n \"relationships\": [\n {\n \"id\": \"\",\n \"linkedCustomerId\": \"\",\n \"relationshipTypeId\": \"\",\n \"linkApp\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"contactSchedule\": \"\",\n \"contactPhone\": \"\",\n \"sharedLoyaltyWallets\": [\n {\n \"loyaltyWalletId\": \"\",\n \"shared\": \"\"\n },\n {\n \"loyaltyWalletId\": \"\",\n \"shared\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"linkedCustomerId\": \"\",\n \"relationshipTypeId\": \"\",\n \"linkApp\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"contactSchedule\": \"\",\n \"contactPhone\": \"\",\n \"sharedLoyaltyWallets\": [\n {\n \"loyaltyWalletId\": \"\",\n \"shared\": \"\"\n },\n {\n \"loyaltyWalletId\": \"\",\n \"shared\": \"\"\n }\n ]\n }\n ],\n \"accountingAccounts\": [\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"customerAccountId\": \"\",\n \"withholdingAccountId\": \"\",\n \"creditorAccountId\": \"\"\n },\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"customerAccountId\": \"\",\n \"withholdingAccountId\": \"\",\n \"creditorAccountId\": \"\"\n }\n ],\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "fee3181c-8364-4467-968d-dcbb4da4b0e4", "name": "Customer updated", "originalRequest": { "url": { "path": [ "api", "v2", "customers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"isCustomer\": \"\",\n \"isSupplier\": \"\",\n \"genericCounterparty\": \"\",\n \"counterpartyType\": \"D\",\n \"checkDigit\": \"\",\n \"taxIdUnvalidated\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"businessName\": \"\",\n \"taxId\": \"\",\n \"birthDate\": \"\",\n \"gender\": \"H\",\n \"maritalStatus\": \"NODEFINIDO\",\n \"profession\": \"\",\n \"blockType\": \"\",\n \"leadType\": \"CL\",\n \"neighbour\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"mobile\": \"\",\n \"phonePrefix\": \"\",\n \"fax\": \"\",\n \"website\": \"\",\n \"contactPerson\": \"\",\n \"contactSchedule\": \"\",\n \"position\": \"\",\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"countryCode\": \"\",\n \"billingAddressId\": \"\",\n \"shippingAddressId\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"customerProfileId\": \"\",\n \"associatedCompanyId\": \"\",\n \"bank\": \"\",\n \"checkingAccount\": \"\",\n \"iban\": \"\",\n \"bic\": \"\",\n \"sepaFormat\": \"CORE\",\n \"mandateSignDate\": \"\",\n \"sepaReference\": \"\",\n \"baseRateId\": \"\",\n \"baseRateQuota\": \"\",\n \"discountRateId\": \"\",\n \"discountRateQuota\": \"\",\n \"discountPercent\": \"\",\n \"paymentTermsId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentDay1\": \"\",\n \"paymentDay2\": \"\",\n \"vatIndicator\": \"N\",\n \"assignedEmployeeId\": \"\",\n \"excludeFromLoyaltyPoints\": \"\",\n \"disability\": \"\",\n \"allowMarketing\": \"\",\n \"allowSurveys\": \"\",\n \"sendReminders\": \"\",\n \"sendSystemNotifications\": \"\",\n \"syncCrm\": \"\",\n \"lopdConsent\": \"\",\n \"feediuId\": \"\",\n \"sourceSystem\": \"\",\n \"observations\": \"\",\n \"documentObservations\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insurerDocumentLimit\": \"\",\n \"satTaxRegime\": \"\",\n \"withholdingAgent\": \"\",\n \"withholdingPercent\": \"\",\n \"receiverActivityCode\": \"\",\n \"idDocumentType\": \"\",\n \"socialSecurity\": \"\",\n \"colombiaEpsCode\": \"\",\n \"allowOrderWithoutDocumentControl\": \"\",\n \"defaultLoyaltyWalletId\": \"\",\n \"directDebitMandateAttachmentId\": \"\",\n \"customerPhotoAttachmentId\": \"\",\n \"noahId\": \"\",\n \"addresses\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"floor\": \"\",\n \"door\": \"\",\n \"building\": \"\",\n \"staircase\": \"\",\n \"apartment\": \"\",\n \"phone\": \"\",\n \"isBillingAddress\": \"\",\n \"isDefaultShippingAddress\": \"\"\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"floor\": \"\",\n \"door\": \"\",\n \"building\": \"\",\n \"staircase\": \"\",\n \"apartment\": \"\",\n \"phone\": \"\",\n \"isBillingAddress\": \"\",\n \"isDefaultShippingAddress\": \"\"\n }\n ],\n \"relationships\": [\n {\n \"id\": \"\",\n \"linkedCustomerId\": \"\",\n \"relationshipTypeId\": \"\",\n \"linkApp\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"contactSchedule\": \"\",\n \"contactPhone\": \"\",\n \"sharedLoyaltyWallets\": [\n {\n \"loyaltyWalletId\": \"\",\n \"shared\": \"\"\n },\n {\n \"loyaltyWalletId\": \"\",\n \"shared\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"linkedCustomerId\": \"\",\n \"relationshipTypeId\": \"\",\n \"linkApp\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"contactSchedule\": \"\",\n \"contactPhone\": \"\",\n \"sharedLoyaltyWallets\": [\n {\n \"loyaltyWalletId\": \"\",\n \"shared\": \"\"\n },\n {\n \"loyaltyWalletId\": \"\",\n \"shared\": \"\"\n }\n ]\n }\n ],\n \"accountingAccounts\": [\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"customerAccountId\": \"\",\n \"withholdingAccountId\": \"\",\n \"creditorAccountId\": \"\"\n },\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"customerAccountId\": \"\",\n \"withholdingAccountId\": \"\",\n \"creditorAccountId\": \"\"\n }\n ],\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"isCustomer\": \"\",\n \"isSupplier\": \"\",\n \"genericCounterparty\": \"\",\n \"counterpartyType\": \"G\",\n \"checkDigit\": \"\",\n \"taxIdUnvalidated\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"businessName\": \"\",\n \"taxId\": \"\",\n \"birthDate\": \"\",\n \"gender\": \"O\",\n \"maritalStatus\": \"SOLTERO\",\n \"profession\": \"\",\n \"blockType\": \"\",\n \"leadType\": \"LEAD\",\n \"neighbour\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"mobile\": \"\",\n \"phonePrefix\": \"\",\n \"fax\": \"\",\n \"website\": \"\",\n \"contactPerson\": \"\",\n \"contactSchedule\": \"\",\n \"position\": \"\",\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"countryCode\": \"\",\n \"billingAddressId\": \"\",\n \"shippingAddressId\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"customerProfileId\": \"\",\n \"associatedCompanyId\": \"\",\n \"lastWarehouseId\": \"\",\n \"lastEmployeeId\": \"\",\n \"bank\": \"\",\n \"checkingAccount\": \"\",\n \"iban\": \"\",\n \"bic\": \"\",\n \"sepaFormat\": \"CORE\",\n \"mandateSignDate\": \"\",\n \"sepaReference\": \"\",\n \"invoiceBalance\": \"\",\n \"baseRateId\": \"\",\n \"baseRateQuota\": \"\",\n \"discountRateId\": \"\",\n \"discountRateQuota\": \"\",\n \"discountPercent\": \"\",\n \"paymentTermsId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentDay1\": \"\",\n \"paymentDay2\": \"\",\n \"vatIndicator\": \"R\",\n \"assignedEmployeeId\": \"\",\n \"excludeFromLoyaltyPoints\": \"\",\n \"disability\": \"\",\n \"allowMarketing\": \"\",\n \"allowSurveys\": \"\",\n \"sendReminders\": \"\",\n \"sendSystemNotifications\": \"\",\n \"syncCrm\": \"\",\n \"lopdConsent\": \"\",\n \"feediuId\": \"\",\n \"sourceSystem\": \"\",\n \"observations\": \"\",\n \"documentObservations\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insurerDocumentLimit\": \"\",\n \"satTaxRegime\": \"\",\n \"withholdingAgent\": \"\",\n \"withholdingPercent\": \"\",\n \"receiverActivityCode\": \"\",\n \"idDocumentType\": \"\",\n \"socialSecurity\": \"\",\n \"colombiaEpsCode\": \"\",\n \"allowOrderWithoutDocumentControl\": \"\",\n \"defaultLoyaltyWalletId\": \"\",\n \"directDebitMandateAttachmentId\": \"\",\n \"customerPhotoAttachmentId\": \"\",\n \"noahId\": \"\",\n \"contacts\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"position\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"position\": \"\"\n }\n ],\n \"addresses\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"country\": \"\",\n \"countryName\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"floor\": \"\",\n \"door\": \"\",\n \"building\": \"\",\n \"staircase\": \"\",\n \"apartment\": \"\",\n \"phone\": \"\",\n \"isBillingAddress\": \"\",\n \"isDefaultShippingAddress\": \"\"\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"country\": \"\",\n \"countryName\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"floor\": \"\",\n \"door\": \"\",\n \"building\": \"\",\n \"staircase\": \"\",\n \"apartment\": \"\",\n \"phone\": \"\",\n \"isBillingAddress\": \"\",\n \"isDefaultShippingAddress\": \"\"\n }\n ],\n \"relationships\": [\n {\n \"id\": \"\",\n \"linkedCustomerId\": \"\",\n \"linkedCustomerDisplayName\": \"\",\n \"linkedCustomerPhone\": \"\",\n \"linkedCustomerLandline\": \"\",\n \"linkedCustomerEmail\": \"\",\n \"linkedCustomerBirthDate\": \"\",\n \"linkedCustomerAge\": \"\",\n \"relationshipTypeId\": \"\",\n \"relationshipTypeName\": \"\",\n \"linkApp\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"contactSchedule\": \"\",\n \"contactPhone\": \"\",\n \"sharedLoyaltyWallets\": [\n {\n \"loyaltyWalletId\": \"\",\n \"cardNumber\": \"\",\n \"customerCode\": \"\",\n \"cardLabel\": \"\",\n \"pointsBalance\": \"\",\n \"monetaryValue\": \"\",\n \"pointsDisplay\": \"\",\n \"shared\": \"\"\n },\n {\n \"loyaltyWalletId\": \"\",\n \"cardNumber\": \"\",\n \"customerCode\": \"\",\n \"cardLabel\": \"\",\n \"pointsBalance\": \"\",\n \"monetaryValue\": \"\",\n \"pointsDisplay\": \"\",\n \"shared\": \"\"\n }\n ],\n \"sharedLoyaltyWalletCount\": \"\"\n },\n {\n \"id\": \"\",\n \"linkedCustomerId\": \"\",\n \"linkedCustomerDisplayName\": \"\",\n \"linkedCustomerPhone\": \"\",\n \"linkedCustomerLandline\": \"\",\n \"linkedCustomerEmail\": \"\",\n \"linkedCustomerBirthDate\": \"\",\n \"linkedCustomerAge\": \"\",\n \"relationshipTypeId\": \"\",\n \"relationshipTypeName\": \"\",\n \"linkApp\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"contactSchedule\": \"\",\n \"contactPhone\": \"\",\n \"sharedLoyaltyWallets\": [\n {\n \"loyaltyWalletId\": \"\",\n \"cardNumber\": \"\",\n \"customerCode\": \"\",\n \"cardLabel\": \"\",\n \"pointsBalance\": \"\",\n \"monetaryValue\": \"\",\n \"pointsDisplay\": \"\",\n \"shared\": \"\"\n },\n {\n \"loyaltyWalletId\": \"\",\n \"cardNumber\": \"\",\n \"customerCode\": \"\",\n \"cardLabel\": \"\",\n \"pointsBalance\": \"\",\n \"monetaryValue\": \"\",\n \"pointsDisplay\": \"\",\n \"shared\": \"\"\n }\n ],\n \"sharedLoyaltyWalletCount\": \"\"\n }\n ],\n \"loyaltyWallets\": [\n {\n \"id\": \"\",\n \"cardNumber\": \"\",\n \"customerCode\": \"\",\n \"cardLabel\": \"\",\n \"pointsBalance\": \"\",\n \"monetaryValue\": \"\",\n \"pointsDisplay\": \"\"\n },\n {\n \"id\": \"\",\n \"cardNumber\": \"\",\n \"customerCode\": \"\",\n \"cardLabel\": \"\",\n \"pointsBalance\": \"\",\n \"monetaryValue\": \"\",\n \"pointsDisplay\": \"\"\n }\n ],\n \"accountingAccounts\": [\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"customerAccountId\": \"\",\n \"customerAccountCode\": \"\",\n \"withholdingAccountId\": \"\",\n \"withholdingAccountCode\": \"\",\n \"creditorAccountId\": \"\",\n \"creditorAccountCode\": \"\"\n },\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"customerAccountId\": \"\",\n \"customerAccountCode\": \"\",\n \"withholdingAccountId\": \"\",\n \"withholdingAccountCode\": \"\",\n \"creditorAccountId\": \"\",\n \"creditorAccountCode\": \"\"\n }\n ],\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"valueType\": \"\",\n \"value\": \"\",\n \"optionId\": \"\",\n \"optionLabel\": \"\",\n \"optionHex\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"valueType\": \"\",\n \"value\": \"\",\n \"optionId\": \"\",\n \"optionLabel\": \"\",\n \"optionHex\": \"\"\n }\n ],\n \"sapCode\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f84fe3f8-f1b3-41d2-9298-38ab6d728629", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "customers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"isCustomer\": \"\",\n \"isSupplier\": \"\",\n \"genericCounterparty\": \"\",\n \"counterpartyType\": \"D\",\n \"checkDigit\": \"\",\n \"taxIdUnvalidated\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"businessName\": \"\",\n \"taxId\": \"\",\n \"birthDate\": \"\",\n \"gender\": \"H\",\n \"maritalStatus\": \"NODEFINIDO\",\n \"profession\": \"\",\n \"blockType\": \"\",\n \"leadType\": \"CL\",\n \"neighbour\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"mobile\": \"\",\n \"phonePrefix\": \"\",\n \"fax\": \"\",\n \"website\": \"\",\n \"contactPerson\": \"\",\n \"contactSchedule\": \"\",\n \"position\": \"\",\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"countryCode\": \"\",\n \"billingAddressId\": \"\",\n \"shippingAddressId\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"customerProfileId\": \"\",\n \"associatedCompanyId\": \"\",\n \"bank\": \"\",\n \"checkingAccount\": \"\",\n \"iban\": \"\",\n \"bic\": \"\",\n \"sepaFormat\": \"CORE\",\n \"mandateSignDate\": \"\",\n \"sepaReference\": \"\",\n \"baseRateId\": \"\",\n \"baseRateQuota\": \"\",\n \"discountRateId\": \"\",\n \"discountRateQuota\": \"\",\n \"discountPercent\": \"\",\n \"paymentTermsId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentDay1\": \"\",\n \"paymentDay2\": \"\",\n \"vatIndicator\": \"N\",\n \"assignedEmployeeId\": \"\",\n \"excludeFromLoyaltyPoints\": \"\",\n \"disability\": \"\",\n \"allowMarketing\": \"\",\n \"allowSurveys\": \"\",\n \"sendReminders\": \"\",\n \"sendSystemNotifications\": \"\",\n \"syncCrm\": \"\",\n \"lopdConsent\": \"\",\n \"feediuId\": \"\",\n \"sourceSystem\": \"\",\n \"observations\": \"\",\n \"documentObservations\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insurerDocumentLimit\": \"\",\n \"satTaxRegime\": \"\",\n \"withholdingAgent\": \"\",\n \"withholdingPercent\": \"\",\n \"receiverActivityCode\": \"\",\n \"idDocumentType\": \"\",\n \"socialSecurity\": \"\",\n \"colombiaEpsCode\": \"\",\n \"allowOrderWithoutDocumentControl\": \"\",\n \"defaultLoyaltyWalletId\": \"\",\n \"directDebitMandateAttachmentId\": \"\",\n \"customerPhotoAttachmentId\": \"\",\n \"noahId\": \"\",\n \"addresses\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"floor\": \"\",\n \"door\": \"\",\n \"building\": \"\",\n \"staircase\": \"\",\n \"apartment\": \"\",\n \"phone\": \"\",\n \"isBillingAddress\": \"\",\n \"isDefaultShippingAddress\": \"\"\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"floor\": \"\",\n \"door\": \"\",\n \"building\": \"\",\n \"staircase\": \"\",\n \"apartment\": \"\",\n \"phone\": \"\",\n \"isBillingAddress\": \"\",\n \"isDefaultShippingAddress\": \"\"\n }\n ],\n \"relationships\": [\n {\n \"id\": \"\",\n \"linkedCustomerId\": \"\",\n \"relationshipTypeId\": \"\",\n \"linkApp\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"contactSchedule\": \"\",\n \"contactPhone\": \"\",\n \"sharedLoyaltyWallets\": [\n {\n \"loyaltyWalletId\": \"\",\n \"shared\": \"\"\n },\n {\n \"loyaltyWalletId\": \"\",\n \"shared\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"linkedCustomerId\": \"\",\n \"relationshipTypeId\": \"\",\n \"linkApp\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"contactSchedule\": \"\",\n \"contactPhone\": \"\",\n \"sharedLoyaltyWallets\": [\n {\n \"loyaltyWalletId\": \"\",\n \"shared\": \"\"\n },\n {\n \"loyaltyWalletId\": \"\",\n \"shared\": \"\"\n }\n ]\n }\n ],\n \"accountingAccounts\": [\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"customerAccountId\": \"\",\n \"withholdingAccountId\": \"\",\n \"creditorAccountId\": \"\"\n },\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"customerAccountId\": \"\",\n \"withholdingAccountId\": \"\",\n \"creditorAccountId\": \"\"\n }\n ],\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "163a44f3-7561-422a-a2c8-c86232d0a7ef", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "customers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"isCustomer\": \"\",\n \"isSupplier\": \"\",\n \"genericCounterparty\": \"\",\n \"counterpartyType\": \"D\",\n \"checkDigit\": \"\",\n \"taxIdUnvalidated\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"businessName\": \"\",\n \"taxId\": \"\",\n \"birthDate\": \"\",\n \"gender\": \"H\",\n \"maritalStatus\": \"NODEFINIDO\",\n \"profession\": \"\",\n \"blockType\": \"\",\n \"leadType\": \"CL\",\n \"neighbour\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"mobile\": \"\",\n \"phonePrefix\": \"\",\n \"fax\": \"\",\n \"website\": \"\",\n \"contactPerson\": \"\",\n \"contactSchedule\": \"\",\n \"position\": \"\",\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"countryCode\": \"\",\n \"billingAddressId\": \"\",\n \"shippingAddressId\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"customerProfileId\": \"\",\n \"associatedCompanyId\": \"\",\n \"bank\": \"\",\n \"checkingAccount\": \"\",\n \"iban\": \"\",\n \"bic\": \"\",\n \"sepaFormat\": \"CORE\",\n \"mandateSignDate\": \"\",\n \"sepaReference\": \"\",\n \"baseRateId\": \"\",\n \"baseRateQuota\": \"\",\n \"discountRateId\": \"\",\n \"discountRateQuota\": \"\",\n \"discountPercent\": \"\",\n \"paymentTermsId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentDay1\": \"\",\n \"paymentDay2\": \"\",\n \"vatIndicator\": \"N\",\n \"assignedEmployeeId\": \"\",\n \"excludeFromLoyaltyPoints\": \"\",\n \"disability\": \"\",\n \"allowMarketing\": \"\",\n \"allowSurveys\": \"\",\n \"sendReminders\": \"\",\n \"sendSystemNotifications\": \"\",\n \"syncCrm\": \"\",\n \"lopdConsent\": \"\",\n \"feediuId\": \"\",\n \"sourceSystem\": \"\",\n \"observations\": \"\",\n \"documentObservations\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insurerDocumentLimit\": \"\",\n \"satTaxRegime\": \"\",\n \"withholdingAgent\": \"\",\n \"withholdingPercent\": \"\",\n \"receiverActivityCode\": \"\",\n \"idDocumentType\": \"\",\n \"socialSecurity\": \"\",\n \"colombiaEpsCode\": \"\",\n \"allowOrderWithoutDocumentControl\": \"\",\n \"defaultLoyaltyWalletId\": \"\",\n \"directDebitMandateAttachmentId\": \"\",\n \"customerPhotoAttachmentId\": \"\",\n \"noahId\": \"\",\n \"addresses\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"floor\": \"\",\n \"door\": \"\",\n \"building\": \"\",\n \"staircase\": \"\",\n \"apartment\": \"\",\n \"phone\": \"\",\n \"isBillingAddress\": \"\",\n \"isDefaultShippingAddress\": \"\"\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"floor\": \"\",\n \"door\": \"\",\n \"building\": \"\",\n \"staircase\": \"\",\n \"apartment\": \"\",\n \"phone\": \"\",\n \"isBillingAddress\": \"\",\n \"isDefaultShippingAddress\": \"\"\n }\n ],\n \"relationships\": [\n {\n \"id\": \"\",\n \"linkedCustomerId\": \"\",\n \"relationshipTypeId\": \"\",\n \"linkApp\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"contactSchedule\": \"\",\n \"contactPhone\": \"\",\n \"sharedLoyaltyWallets\": [\n {\n \"loyaltyWalletId\": \"\",\n \"shared\": \"\"\n },\n {\n \"loyaltyWalletId\": \"\",\n \"shared\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"linkedCustomerId\": \"\",\n \"relationshipTypeId\": \"\",\n \"linkApp\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"contactSchedule\": \"\",\n \"contactPhone\": \"\",\n \"sharedLoyaltyWallets\": [\n {\n \"loyaltyWalletId\": \"\",\n \"shared\": \"\"\n },\n {\n \"loyaltyWalletId\": \"\",\n \"shared\": \"\"\n }\n ]\n }\n ],\n \"accountingAccounts\": [\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"customerAccountId\": \"\",\n \"withholdingAccountId\": \"\",\n \"creditorAccountId\": \"\"\n },\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"customerAccountId\": \"\",\n \"withholdingAccountId\": \"\",\n \"creditorAccountId\": \"\"\n }\n ],\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0a9ce2a0-96cd-4a4b-8c9c-373123b88209", "name": "Authenticated user is missing the `EDITAR_CLIENTES` permission", "originalRequest": { "url": { "path": [ "api", "v2", "customers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"isCustomer\": \"\",\n \"isSupplier\": \"\",\n \"genericCounterparty\": \"\",\n \"counterpartyType\": \"D\",\n \"checkDigit\": \"\",\n \"taxIdUnvalidated\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"businessName\": \"\",\n \"taxId\": \"\",\n \"birthDate\": \"\",\n \"gender\": \"H\",\n \"maritalStatus\": \"NODEFINIDO\",\n \"profession\": \"\",\n \"blockType\": \"\",\n \"leadType\": \"CL\",\n \"neighbour\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"mobile\": \"\",\n \"phonePrefix\": \"\",\n \"fax\": \"\",\n \"website\": \"\",\n \"contactPerson\": \"\",\n \"contactSchedule\": \"\",\n \"position\": \"\",\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"countryCode\": \"\",\n \"billingAddressId\": \"\",\n \"shippingAddressId\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"customerProfileId\": \"\",\n \"associatedCompanyId\": \"\",\n \"bank\": \"\",\n \"checkingAccount\": \"\",\n \"iban\": \"\",\n \"bic\": \"\",\n \"sepaFormat\": \"CORE\",\n \"mandateSignDate\": \"\",\n \"sepaReference\": \"\",\n \"baseRateId\": \"\",\n \"baseRateQuota\": \"\",\n \"discountRateId\": \"\",\n \"discountRateQuota\": \"\",\n \"discountPercent\": \"\",\n \"paymentTermsId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentDay1\": \"\",\n \"paymentDay2\": \"\",\n \"vatIndicator\": \"N\",\n \"assignedEmployeeId\": \"\",\n \"excludeFromLoyaltyPoints\": \"\",\n \"disability\": \"\",\n \"allowMarketing\": \"\",\n \"allowSurveys\": \"\",\n \"sendReminders\": \"\",\n \"sendSystemNotifications\": \"\",\n \"syncCrm\": \"\",\n \"lopdConsent\": \"\",\n \"feediuId\": \"\",\n \"sourceSystem\": \"\",\n \"observations\": \"\",\n \"documentObservations\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insurerDocumentLimit\": \"\",\n \"satTaxRegime\": \"\",\n \"withholdingAgent\": \"\",\n \"withholdingPercent\": \"\",\n \"receiverActivityCode\": \"\",\n \"idDocumentType\": \"\",\n \"socialSecurity\": \"\",\n \"colombiaEpsCode\": \"\",\n \"allowOrderWithoutDocumentControl\": \"\",\n \"defaultLoyaltyWalletId\": \"\",\n \"directDebitMandateAttachmentId\": \"\",\n \"customerPhotoAttachmentId\": \"\",\n \"noahId\": \"\",\n \"addresses\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"floor\": \"\",\n \"door\": \"\",\n \"building\": \"\",\n \"staircase\": \"\",\n \"apartment\": \"\",\n \"phone\": \"\",\n \"isBillingAddress\": \"\",\n \"isDefaultShippingAddress\": \"\"\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"floor\": \"\",\n \"door\": \"\",\n \"building\": \"\",\n \"staircase\": \"\",\n \"apartment\": \"\",\n \"phone\": \"\",\n \"isBillingAddress\": \"\",\n \"isDefaultShippingAddress\": \"\"\n }\n ],\n \"relationships\": [\n {\n \"id\": \"\",\n \"linkedCustomerId\": \"\",\n \"relationshipTypeId\": \"\",\n \"linkApp\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"contactSchedule\": \"\",\n \"contactPhone\": \"\",\n \"sharedLoyaltyWallets\": [\n {\n \"loyaltyWalletId\": \"\",\n \"shared\": \"\"\n },\n {\n \"loyaltyWalletId\": \"\",\n \"shared\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"linkedCustomerId\": \"\",\n \"relationshipTypeId\": \"\",\n \"linkApp\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"contactSchedule\": \"\",\n \"contactPhone\": \"\",\n \"sharedLoyaltyWallets\": [\n {\n \"loyaltyWalletId\": \"\",\n \"shared\": \"\"\n },\n {\n \"loyaltyWalletId\": \"\",\n \"shared\": \"\"\n }\n ]\n }\n ],\n \"accountingAccounts\": [\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"customerAccountId\": \"\",\n \"withholdingAccountId\": \"\",\n \"creditorAccountId\": \"\"\n },\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"customerAccountId\": \"\",\n \"withholdingAccountId\": \"\",\n \"creditorAccountId\": \"\"\n }\n ],\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fd7053a6-914a-4959-9247-ad8c02b5da30", "name": "Customer not found", "originalRequest": { "url": { "path": [ "api", "v2", "customers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"isCustomer\": \"\",\n \"isSupplier\": \"\",\n \"genericCounterparty\": \"\",\n \"counterpartyType\": \"D\",\n \"checkDigit\": \"\",\n \"taxIdUnvalidated\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"businessName\": \"\",\n \"taxId\": \"\",\n \"birthDate\": \"\",\n \"gender\": \"H\",\n \"maritalStatus\": \"NODEFINIDO\",\n \"profession\": \"\",\n \"blockType\": \"\",\n \"leadType\": \"CL\",\n \"neighbour\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"mobile\": \"\",\n \"phonePrefix\": \"\",\n \"fax\": \"\",\n \"website\": \"\",\n \"contactPerson\": \"\",\n \"contactSchedule\": \"\",\n \"position\": \"\",\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"countryCode\": \"\",\n \"billingAddressId\": \"\",\n \"shippingAddressId\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"customerProfileId\": \"\",\n \"associatedCompanyId\": \"\",\n \"bank\": \"\",\n \"checkingAccount\": \"\",\n \"iban\": \"\",\n \"bic\": \"\",\n \"sepaFormat\": \"CORE\",\n \"mandateSignDate\": \"\",\n \"sepaReference\": \"\",\n \"baseRateId\": \"\",\n \"baseRateQuota\": \"\",\n \"discountRateId\": \"\",\n \"discountRateQuota\": \"\",\n \"discountPercent\": \"\",\n \"paymentTermsId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentDay1\": \"\",\n \"paymentDay2\": \"\",\n \"vatIndicator\": \"N\",\n \"assignedEmployeeId\": \"\",\n \"excludeFromLoyaltyPoints\": \"\",\n \"disability\": \"\",\n \"allowMarketing\": \"\",\n \"allowSurveys\": \"\",\n \"sendReminders\": \"\",\n \"sendSystemNotifications\": \"\",\n \"syncCrm\": \"\",\n \"lopdConsent\": \"\",\n \"feediuId\": \"\",\n \"sourceSystem\": \"\",\n \"observations\": \"\",\n \"documentObservations\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insurerDocumentLimit\": \"\",\n \"satTaxRegime\": \"\",\n \"withholdingAgent\": \"\",\n \"withholdingPercent\": \"\",\n \"receiverActivityCode\": \"\",\n \"idDocumentType\": \"\",\n \"socialSecurity\": \"\",\n \"colombiaEpsCode\": \"\",\n \"allowOrderWithoutDocumentControl\": \"\",\n \"defaultLoyaltyWalletId\": \"\",\n \"directDebitMandateAttachmentId\": \"\",\n \"customerPhotoAttachmentId\": \"\",\n \"noahId\": \"\",\n \"addresses\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"floor\": \"\",\n \"door\": \"\",\n \"building\": \"\",\n \"staircase\": \"\",\n \"apartment\": \"\",\n \"phone\": \"\",\n \"isBillingAddress\": \"\",\n \"isDefaultShippingAddress\": \"\"\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"floor\": \"\",\n \"door\": \"\",\n \"building\": \"\",\n \"staircase\": \"\",\n \"apartment\": \"\",\n \"phone\": \"\",\n \"isBillingAddress\": \"\",\n \"isDefaultShippingAddress\": \"\"\n }\n ],\n \"relationships\": [\n {\n \"id\": \"\",\n \"linkedCustomerId\": \"\",\n \"relationshipTypeId\": \"\",\n \"linkApp\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"contactSchedule\": \"\",\n \"contactPhone\": \"\",\n \"sharedLoyaltyWallets\": [\n {\n \"loyaltyWalletId\": \"\",\n \"shared\": \"\"\n },\n {\n \"loyaltyWalletId\": \"\",\n \"shared\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"linkedCustomerId\": \"\",\n \"relationshipTypeId\": \"\",\n \"linkApp\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"contactSchedule\": \"\",\n \"contactPhone\": \"\",\n \"sharedLoyaltyWallets\": [\n {\n \"loyaltyWalletId\": \"\",\n \"shared\": \"\"\n },\n {\n \"loyaltyWalletId\": \"\",\n \"shared\": \"\"\n }\n ]\n }\n ],\n \"accountingAccounts\": [\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"customerAccountId\": \"\",\n \"withholdingAccountId\": \"\",\n \"creditorAccountId\": \"\"\n },\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"customerAccountId\": \"\",\n \"withholdingAccountId\": \"\",\n \"creditorAccountId\": \"\"\n }\n ],\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "aca9b12b-c601-4f68-8e4b-e1a3ad3365af", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "customers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"isCustomer\": \"\",\n \"isSupplier\": \"\",\n \"genericCounterparty\": \"\",\n \"counterpartyType\": \"D\",\n \"checkDigit\": \"\",\n \"taxIdUnvalidated\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"businessName\": \"\",\n \"taxId\": \"\",\n \"birthDate\": \"\",\n \"gender\": \"H\",\n \"maritalStatus\": \"NODEFINIDO\",\n \"profession\": \"\",\n \"blockType\": \"\",\n \"leadType\": \"CL\",\n \"neighbour\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"mobile\": \"\",\n \"phonePrefix\": \"\",\n \"fax\": \"\",\n \"website\": \"\",\n \"contactPerson\": \"\",\n \"contactSchedule\": \"\",\n \"position\": \"\",\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"countryCode\": \"\",\n \"billingAddressId\": \"\",\n \"shippingAddressId\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"customerProfileId\": \"\",\n \"associatedCompanyId\": \"\",\n \"bank\": \"\",\n \"checkingAccount\": \"\",\n \"iban\": \"\",\n \"bic\": \"\",\n \"sepaFormat\": \"CORE\",\n \"mandateSignDate\": \"\",\n \"sepaReference\": \"\",\n \"baseRateId\": \"\",\n \"baseRateQuota\": \"\",\n \"discountRateId\": \"\",\n \"discountRateQuota\": \"\",\n \"discountPercent\": \"\",\n \"paymentTermsId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentDay1\": \"\",\n \"paymentDay2\": \"\",\n \"vatIndicator\": \"N\",\n \"assignedEmployeeId\": \"\",\n \"excludeFromLoyaltyPoints\": \"\",\n \"disability\": \"\",\n \"allowMarketing\": \"\",\n \"allowSurveys\": \"\",\n \"sendReminders\": \"\",\n \"sendSystemNotifications\": \"\",\n \"syncCrm\": \"\",\n \"lopdConsent\": \"\",\n \"feediuId\": \"\",\n \"sourceSystem\": \"\",\n \"observations\": \"\",\n \"documentObservations\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insurerDocumentLimit\": \"\",\n \"satTaxRegime\": \"\",\n \"withholdingAgent\": \"\",\n \"withholdingPercent\": \"\",\n \"receiverActivityCode\": \"\",\n \"idDocumentType\": \"\",\n \"socialSecurity\": \"\",\n \"colombiaEpsCode\": \"\",\n \"allowOrderWithoutDocumentControl\": \"\",\n \"defaultLoyaltyWalletId\": \"\",\n \"directDebitMandateAttachmentId\": \"\",\n \"customerPhotoAttachmentId\": \"\",\n \"noahId\": \"\",\n \"addresses\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"floor\": \"\",\n \"door\": \"\",\n \"building\": \"\",\n \"staircase\": \"\",\n \"apartment\": \"\",\n \"phone\": \"\",\n \"isBillingAddress\": \"\",\n \"isDefaultShippingAddress\": \"\"\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"floor\": \"\",\n \"door\": \"\",\n \"building\": \"\",\n \"staircase\": \"\",\n \"apartment\": \"\",\n \"phone\": \"\",\n \"isBillingAddress\": \"\",\n \"isDefaultShippingAddress\": \"\"\n }\n ],\n \"relationships\": [\n {\n \"id\": \"\",\n \"linkedCustomerId\": \"\",\n \"relationshipTypeId\": \"\",\n \"linkApp\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"contactSchedule\": \"\",\n \"contactPhone\": \"\",\n \"sharedLoyaltyWallets\": [\n {\n \"loyaltyWalletId\": \"\",\n \"shared\": \"\"\n },\n {\n \"loyaltyWalletId\": \"\",\n \"shared\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"linkedCustomerId\": \"\",\n \"relationshipTypeId\": \"\",\n \"linkApp\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"contactSchedule\": \"\",\n \"contactPhone\": \"\",\n \"sharedLoyaltyWallets\": [\n {\n \"loyaltyWalletId\": \"\",\n \"shared\": \"\"\n },\n {\n \"loyaltyWalletId\": \"\",\n \"shared\": \"\"\n }\n ]\n }\n ],\n \"accountingAccounts\": [\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"customerAccountId\": \"\",\n \"withholdingAccountId\": \"\",\n \"creditorAccountId\": \"\"\n },\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"customerAccountId\": \"\",\n \"withholdingAccountId\": \"\",\n \"creditorAccountId\": \"\"\n }\n ],\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "025172bf-8d67-4ad2-8806-1082d1d1ebc5", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "customers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"isCustomer\": \"\",\n \"isSupplier\": \"\",\n \"genericCounterparty\": \"\",\n \"counterpartyType\": \"D\",\n \"checkDigit\": \"\",\n \"taxIdUnvalidated\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"businessName\": \"\",\n \"taxId\": \"\",\n \"birthDate\": \"\",\n \"gender\": \"H\",\n \"maritalStatus\": \"NODEFINIDO\",\n \"profession\": \"\",\n \"blockType\": \"\",\n \"leadType\": \"CL\",\n \"neighbour\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"mobile\": \"\",\n \"phonePrefix\": \"\",\n \"fax\": \"\",\n \"website\": \"\",\n \"contactPerson\": \"\",\n \"contactSchedule\": \"\",\n \"position\": \"\",\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"countryCode\": \"\",\n \"billingAddressId\": \"\",\n \"shippingAddressId\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"customerProfileId\": \"\",\n \"associatedCompanyId\": \"\",\n \"bank\": \"\",\n \"checkingAccount\": \"\",\n \"iban\": \"\",\n \"bic\": \"\",\n \"sepaFormat\": \"CORE\",\n \"mandateSignDate\": \"\",\n \"sepaReference\": \"\",\n \"baseRateId\": \"\",\n \"baseRateQuota\": \"\",\n \"discountRateId\": \"\",\n \"discountRateQuota\": \"\",\n \"discountPercent\": \"\",\n \"paymentTermsId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentDay1\": \"\",\n \"paymentDay2\": \"\",\n \"vatIndicator\": \"N\",\n \"assignedEmployeeId\": \"\",\n \"excludeFromLoyaltyPoints\": \"\",\n \"disability\": \"\",\n \"allowMarketing\": \"\",\n \"allowSurveys\": \"\",\n \"sendReminders\": \"\",\n \"sendSystemNotifications\": \"\",\n \"syncCrm\": \"\",\n \"lopdConsent\": \"\",\n \"feediuId\": \"\",\n \"sourceSystem\": \"\",\n \"observations\": \"\",\n \"documentObservations\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insurerDocumentLimit\": \"\",\n \"satTaxRegime\": \"\",\n \"withholdingAgent\": \"\",\n \"withholdingPercent\": \"\",\n \"receiverActivityCode\": \"\",\n \"idDocumentType\": \"\",\n \"socialSecurity\": \"\",\n \"colombiaEpsCode\": \"\",\n \"allowOrderWithoutDocumentControl\": \"\",\n \"defaultLoyaltyWalletId\": \"\",\n \"directDebitMandateAttachmentId\": \"\",\n \"customerPhotoAttachmentId\": \"\",\n \"noahId\": \"\",\n \"addresses\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"floor\": \"\",\n \"door\": \"\",\n \"building\": \"\",\n \"staircase\": \"\",\n \"apartment\": \"\",\n \"phone\": \"\",\n \"isBillingAddress\": \"\",\n \"isDefaultShippingAddress\": \"\"\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"floor\": \"\",\n \"door\": \"\",\n \"building\": \"\",\n \"staircase\": \"\",\n \"apartment\": \"\",\n \"phone\": \"\",\n \"isBillingAddress\": \"\",\n \"isDefaultShippingAddress\": \"\"\n }\n ],\n \"relationships\": [\n {\n \"id\": \"\",\n \"linkedCustomerId\": \"\",\n \"relationshipTypeId\": \"\",\n \"linkApp\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"contactSchedule\": \"\",\n \"contactPhone\": \"\",\n \"sharedLoyaltyWallets\": [\n {\n \"loyaltyWalletId\": \"\",\n \"shared\": \"\"\n },\n {\n \"loyaltyWalletId\": \"\",\n \"shared\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"linkedCustomerId\": \"\",\n \"relationshipTypeId\": \"\",\n \"linkApp\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"contactSchedule\": \"\",\n \"contactPhone\": \"\",\n \"sharedLoyaltyWallets\": [\n {\n \"loyaltyWalletId\": \"\",\n \"shared\": \"\"\n },\n {\n \"loyaltyWalletId\": \"\",\n \"shared\": \"\"\n }\n ]\n }\n ],\n \"accountingAccounts\": [\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"customerAccountId\": \"\",\n \"withholdingAccountId\": \"\",\n \"creditorAccountId\": \"\"\n },\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"customerAccountId\": \"\",\n \"withholdingAccountId\": \"\",\n \"creditorAccountId\": \"\"\n }\n ],\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "42efa124-08d3-455d-9db6-1b9aa68dd957", "name": "Delete customer", "request": { "name": "Delete customer", "description": { "content": "Deletes a customer. Send the `If-Match` header with the current ETag for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "customers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Customer ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "43453a3a-7235-45a1-8181-d0c494b35b1e", "name": "Customer deleted", "originalRequest": { "url": { "path": [ "api", "v2", "customers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3766f216-d202-456d-8560-6c67d9c0c145", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "customers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c922391e-c923-401b-8ecb-01f27211a52f", "name": "Authenticated user is missing the `BORRAR_CLIENTES` permission", "originalRequest": { "url": { "path": [ "api", "v2", "customers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "39d1c45f-f382-4826-b1fe-640538079c5d", "name": "Customer not found", "originalRequest": { "url": { "path": [ "api", "v2", "customers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d7924f7e-f63e-4765-a9c3-7844230bb128", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "customers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5a61f1a6-0151-4646-8fca-6b6db1477fb0", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "customers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "65551c8a-96f3-4889-a066-1ebd03f7b7d7", "name": "Merge-patch customer", "request": { "name": "Merge-patch customer", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "customers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Customer ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "a70cef95-8f12-4c96-8901-0565ecbc409d", "name": "Customer patched", "originalRequest": { "url": { "path": [ "api", "v2", "customers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"isCustomer\": \"\",\n \"isSupplier\": \"\",\n \"genericCounterparty\": \"\",\n \"counterpartyType\": \"G\",\n \"checkDigit\": \"\",\n \"taxIdUnvalidated\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"businessName\": \"\",\n \"taxId\": \"\",\n \"birthDate\": \"\",\n \"gender\": \"O\",\n \"maritalStatus\": \"SOLTERO\",\n \"profession\": \"\",\n \"blockType\": \"\",\n \"leadType\": \"LEAD\",\n \"neighbour\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"mobile\": \"\",\n \"phonePrefix\": \"\",\n \"fax\": \"\",\n \"website\": \"\",\n \"contactPerson\": \"\",\n \"contactSchedule\": \"\",\n \"position\": \"\",\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"countryCode\": \"\",\n \"billingAddressId\": \"\",\n \"shippingAddressId\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"customerProfileId\": \"\",\n \"associatedCompanyId\": \"\",\n \"lastWarehouseId\": \"\",\n \"lastEmployeeId\": \"\",\n \"bank\": \"\",\n \"checkingAccount\": \"\",\n \"iban\": \"\",\n \"bic\": \"\",\n \"sepaFormat\": \"CORE\",\n \"mandateSignDate\": \"\",\n \"sepaReference\": \"\",\n \"invoiceBalance\": \"\",\n \"baseRateId\": \"\",\n \"baseRateQuota\": \"\",\n \"discountRateId\": \"\",\n \"discountRateQuota\": \"\",\n \"discountPercent\": \"\",\n \"paymentTermsId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentDay1\": \"\",\n \"paymentDay2\": \"\",\n \"vatIndicator\": \"R\",\n \"assignedEmployeeId\": \"\",\n \"excludeFromLoyaltyPoints\": \"\",\n \"disability\": \"\",\n \"allowMarketing\": \"\",\n \"allowSurveys\": \"\",\n \"sendReminders\": \"\",\n \"sendSystemNotifications\": \"\",\n \"syncCrm\": \"\",\n \"lopdConsent\": \"\",\n \"feediuId\": \"\",\n \"sourceSystem\": \"\",\n \"observations\": \"\",\n \"documentObservations\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insurerDocumentLimit\": \"\",\n \"satTaxRegime\": \"\",\n \"withholdingAgent\": \"\",\n \"withholdingPercent\": \"\",\n \"receiverActivityCode\": \"\",\n \"idDocumentType\": \"\",\n \"socialSecurity\": \"\",\n \"colombiaEpsCode\": \"\",\n \"allowOrderWithoutDocumentControl\": \"\",\n \"defaultLoyaltyWalletId\": \"\",\n \"directDebitMandateAttachmentId\": \"\",\n \"customerPhotoAttachmentId\": \"\",\n \"noahId\": \"\",\n \"contacts\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"position\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"position\": \"\"\n }\n ],\n \"addresses\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"country\": \"\",\n \"countryName\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"floor\": \"\",\n \"door\": \"\",\n \"building\": \"\",\n \"staircase\": \"\",\n \"apartment\": \"\",\n \"phone\": \"\",\n \"isBillingAddress\": \"\",\n \"isDefaultShippingAddress\": \"\"\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"country\": \"\",\n \"countryName\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"floor\": \"\",\n \"door\": \"\",\n \"building\": \"\",\n \"staircase\": \"\",\n \"apartment\": \"\",\n \"phone\": \"\",\n \"isBillingAddress\": \"\",\n \"isDefaultShippingAddress\": \"\"\n }\n ],\n \"relationships\": [\n {\n \"id\": \"\",\n \"linkedCustomerId\": \"\",\n \"linkedCustomerDisplayName\": \"\",\n \"linkedCustomerPhone\": \"\",\n \"linkedCustomerLandline\": \"\",\n \"linkedCustomerEmail\": \"\",\n \"linkedCustomerBirthDate\": \"\",\n \"linkedCustomerAge\": \"\",\n \"relationshipTypeId\": \"\",\n \"relationshipTypeName\": \"\",\n \"linkApp\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"contactSchedule\": \"\",\n \"contactPhone\": \"\",\n \"sharedLoyaltyWallets\": [\n {\n \"loyaltyWalletId\": \"\",\n \"cardNumber\": \"\",\n \"customerCode\": \"\",\n \"cardLabel\": \"\",\n \"pointsBalance\": \"\",\n \"monetaryValue\": \"\",\n \"pointsDisplay\": \"\",\n \"shared\": \"\"\n },\n {\n \"loyaltyWalletId\": \"\",\n \"cardNumber\": \"\",\n \"customerCode\": \"\",\n \"cardLabel\": \"\",\n \"pointsBalance\": \"\",\n \"monetaryValue\": \"\",\n \"pointsDisplay\": \"\",\n \"shared\": \"\"\n }\n ],\n \"sharedLoyaltyWalletCount\": \"\"\n },\n {\n \"id\": \"\",\n \"linkedCustomerId\": \"\",\n \"linkedCustomerDisplayName\": \"\",\n \"linkedCustomerPhone\": \"\",\n \"linkedCustomerLandline\": \"\",\n \"linkedCustomerEmail\": \"\",\n \"linkedCustomerBirthDate\": \"\",\n \"linkedCustomerAge\": \"\",\n \"relationshipTypeId\": \"\",\n \"relationshipTypeName\": \"\",\n \"linkApp\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"contactSchedule\": \"\",\n \"contactPhone\": \"\",\n \"sharedLoyaltyWallets\": [\n {\n \"loyaltyWalletId\": \"\",\n \"cardNumber\": \"\",\n \"customerCode\": \"\",\n \"cardLabel\": \"\",\n \"pointsBalance\": \"\",\n \"monetaryValue\": \"\",\n \"pointsDisplay\": \"\",\n \"shared\": \"\"\n },\n {\n \"loyaltyWalletId\": \"\",\n \"cardNumber\": \"\",\n \"customerCode\": \"\",\n \"cardLabel\": \"\",\n \"pointsBalance\": \"\",\n \"monetaryValue\": \"\",\n \"pointsDisplay\": \"\",\n \"shared\": \"\"\n }\n ],\n \"sharedLoyaltyWalletCount\": \"\"\n }\n ],\n \"loyaltyWallets\": [\n {\n \"id\": \"\",\n \"cardNumber\": \"\",\n \"customerCode\": \"\",\n \"cardLabel\": \"\",\n \"pointsBalance\": \"\",\n \"monetaryValue\": \"\",\n \"pointsDisplay\": \"\"\n },\n {\n \"id\": \"\",\n \"cardNumber\": \"\",\n \"customerCode\": \"\",\n \"cardLabel\": \"\",\n \"pointsBalance\": \"\",\n \"monetaryValue\": \"\",\n \"pointsDisplay\": \"\"\n }\n ],\n \"accountingAccounts\": [\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"customerAccountId\": \"\",\n \"customerAccountCode\": \"\",\n \"withholdingAccountId\": \"\",\n \"withholdingAccountCode\": \"\",\n \"creditorAccountId\": \"\",\n \"creditorAccountCode\": \"\"\n },\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"customerAccountId\": \"\",\n \"customerAccountCode\": \"\",\n \"withholdingAccountId\": \"\",\n \"withholdingAccountCode\": \"\",\n \"creditorAccountId\": \"\",\n \"creditorAccountCode\": \"\"\n }\n ],\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"valueType\": \"\",\n \"value\": \"\",\n \"optionId\": \"\",\n \"optionLabel\": \"\",\n \"optionHex\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"valueType\": \"\",\n \"value\": \"\",\n \"optionId\": \"\",\n \"optionLabel\": \"\",\n \"optionHex\": \"\"\n }\n ],\n \"sapCode\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "eed1d199-32cd-4802-b54f-09a3e0b16148", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details. Also returned for malformed merge-patch payloads.", "originalRequest": { "url": { "path": [ "api", "v2", "customers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b382d44d-f674-4c54-9066-313a344a68e4", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "customers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "72b6d680-2c95-43d3-96fb-421edf3a9feb", "name": "Authenticated user is missing the `EDITAR_CLIENTES` permission", "originalRequest": { "url": { "path": [ "api", "v2", "customers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "72992293-29aa-4016-8450-55a4bd1ef4e0", "name": "Customer not found", "originalRequest": { "url": { "path": [ "api", "v2", "customers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8c1c7b9f-bffc-4cf2-93ac-f89d12895177", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "customers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "87d1ee2d-50c9-4758-b953-c23c033dcb18", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "customers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "04bace9c-8ec2-419e-83fc-1cd927771134", "name": "List customers", "request": { "name": "List customers", "description": { "content": "Returns a paginated list of customers with envelope `{data, totalCount, skip, limit, hasMore}`. Supports optional RSQL `filter`, `sort` (default `lastModifiedAt:desc`), `skip`/`limit` pagination and `modifiedAfter`/`modifiedBefore` bookends. Limit is capped at 200; skip is clamped to >= 0.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "customers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "1d461c3d-7180-4a55-987d-39cf29b37117", "name": "Page of customers", "originalRequest": { "url": { "path": [ "api", "v2", "customers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ca3e9463-68a5-45e6-956e-de17b6e9919d", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "customers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "57e9663c-320a-44cc-8993-cd0798594783", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "customers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "46962dc5-a5ec-4382-8dff-23b95b1da76a", "name": "Authenticated user is missing the `VER_CLIENTES` permission", "originalRequest": { "url": { "path": [ "api", "v2", "customers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e9aa8a54-0998-4d1e-9321-02f5b9cac14f", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "customers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2f42afb8-1c17-4148-b8c1-ffabca01dfda", "name": "Create customer", "request": { "name": "Create customer", "description": { "content": "Creates a new customer (tercero). Business logic runs in the legacy WAR via the internal commands gateway.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "customers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"isCustomer\": \"\",\n \"isSupplier\": \"\",\n \"genericCounterparty\": \"\",\n \"counterpartyType\": \"D\",\n \"checkDigit\": \"\",\n \"taxIdUnvalidated\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"businessName\": \"\",\n \"taxId\": \"\",\n \"birthDate\": \"\",\n \"gender\": \"H\",\n \"maritalStatus\": \"NODEFINIDO\",\n \"profession\": \"\",\n \"blockType\": \"\",\n \"leadType\": \"CL\",\n \"neighbour\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"mobile\": \"\",\n \"phonePrefix\": \"\",\n \"fax\": \"\",\n \"website\": \"\",\n \"contactPerson\": \"\",\n \"contactSchedule\": \"\",\n \"position\": \"\",\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"countryCode\": \"\",\n \"billingAddressId\": \"\",\n \"shippingAddressId\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"customerProfileId\": \"\",\n \"associatedCompanyId\": \"\",\n \"bank\": \"\",\n \"checkingAccount\": \"\",\n \"iban\": \"\",\n \"bic\": \"\",\n \"sepaFormat\": \"CORE\",\n \"mandateSignDate\": \"\",\n \"sepaReference\": \"\",\n \"baseRateId\": \"\",\n \"baseRateQuota\": \"\",\n \"discountRateId\": \"\",\n \"discountRateQuota\": \"\",\n \"discountPercent\": \"\",\n \"paymentTermsId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentDay1\": \"\",\n \"paymentDay2\": \"\",\n \"vatIndicator\": \"N\",\n \"assignedEmployeeId\": \"\",\n \"excludeFromLoyaltyPoints\": \"\",\n \"disability\": \"\",\n \"allowMarketing\": \"\",\n \"allowSurveys\": \"\",\n \"sendReminders\": \"\",\n \"sendSystemNotifications\": \"\",\n \"syncCrm\": \"\",\n \"lopdConsent\": \"\",\n \"feediuId\": \"\",\n \"sourceSystem\": \"\",\n \"observations\": \"\",\n \"documentObservations\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insurerDocumentLimit\": \"\",\n \"satTaxRegime\": \"\",\n \"withholdingAgent\": \"\",\n \"withholdingPercent\": \"\",\n \"receiverActivityCode\": \"\",\n \"idDocumentType\": \"\",\n \"socialSecurity\": \"\",\n \"colombiaEpsCode\": \"\",\n \"allowOrderWithoutDocumentControl\": \"\",\n \"defaultLoyaltyWalletId\": \"\",\n \"directDebitMandateAttachmentId\": \"\",\n \"customerPhotoAttachmentId\": \"\",\n \"noahId\": \"\",\n \"addresses\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"floor\": \"\",\n \"door\": \"\",\n \"building\": \"\",\n \"staircase\": \"\",\n \"apartment\": \"\",\n \"phone\": \"\",\n \"isBillingAddress\": \"\",\n \"isDefaultShippingAddress\": \"\"\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"floor\": \"\",\n \"door\": \"\",\n \"building\": \"\",\n \"staircase\": \"\",\n \"apartment\": \"\",\n \"phone\": \"\",\n \"isBillingAddress\": \"\",\n \"isDefaultShippingAddress\": \"\"\n }\n ],\n \"relationships\": [\n {\n \"id\": \"\",\n \"linkedCustomerId\": \"\",\n \"relationshipTypeId\": \"\",\n \"linkApp\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"contactSchedule\": \"\",\n \"contactPhone\": \"\",\n \"sharedLoyaltyWallets\": [\n {\n \"loyaltyWalletId\": \"\",\n \"shared\": \"\"\n },\n {\n \"loyaltyWalletId\": \"\",\n \"shared\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"linkedCustomerId\": \"\",\n \"relationshipTypeId\": \"\",\n \"linkApp\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"contactSchedule\": \"\",\n \"contactPhone\": \"\",\n \"sharedLoyaltyWallets\": [\n {\n \"loyaltyWalletId\": \"\",\n \"shared\": \"\"\n },\n {\n \"loyaltyWalletId\": \"\",\n \"shared\": \"\"\n }\n ]\n }\n ],\n \"accountingAccounts\": [\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"customerAccountId\": \"\",\n \"withholdingAccountId\": \"\",\n \"creditorAccountId\": \"\"\n },\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"customerAccountId\": \"\",\n \"withholdingAccountId\": \"\",\n \"creditorAccountId\": \"\"\n }\n ],\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "2bb302bf-655a-4270-9fa6-b20b69d36ef4", "name": "Customer created", "originalRequest": { "url": { "path": [ "api", "v2", "customers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"isCustomer\": \"\",\n \"isSupplier\": \"\",\n \"genericCounterparty\": \"\",\n \"counterpartyType\": \"D\",\n \"checkDigit\": \"\",\n \"taxIdUnvalidated\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"businessName\": \"\",\n \"taxId\": \"\",\n \"birthDate\": \"\",\n \"gender\": \"H\",\n \"maritalStatus\": \"NODEFINIDO\",\n \"profession\": \"\",\n \"blockType\": \"\",\n \"leadType\": \"CL\",\n \"neighbour\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"mobile\": \"\",\n \"phonePrefix\": \"\",\n \"fax\": \"\",\n \"website\": \"\",\n \"contactPerson\": \"\",\n \"contactSchedule\": \"\",\n \"position\": \"\",\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"countryCode\": \"\",\n \"billingAddressId\": \"\",\n \"shippingAddressId\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"customerProfileId\": \"\",\n \"associatedCompanyId\": \"\",\n \"bank\": \"\",\n \"checkingAccount\": \"\",\n \"iban\": \"\",\n \"bic\": \"\",\n \"sepaFormat\": \"CORE\",\n \"mandateSignDate\": \"\",\n \"sepaReference\": \"\",\n \"baseRateId\": \"\",\n \"baseRateQuota\": \"\",\n \"discountRateId\": \"\",\n \"discountRateQuota\": \"\",\n \"discountPercent\": \"\",\n \"paymentTermsId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentDay1\": \"\",\n \"paymentDay2\": \"\",\n \"vatIndicator\": \"N\",\n \"assignedEmployeeId\": \"\",\n \"excludeFromLoyaltyPoints\": \"\",\n \"disability\": \"\",\n \"allowMarketing\": \"\",\n \"allowSurveys\": \"\",\n \"sendReminders\": \"\",\n \"sendSystemNotifications\": \"\",\n \"syncCrm\": \"\",\n \"lopdConsent\": \"\",\n \"feediuId\": \"\",\n \"sourceSystem\": \"\",\n \"observations\": \"\",\n \"documentObservations\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insurerDocumentLimit\": \"\",\n \"satTaxRegime\": \"\",\n \"withholdingAgent\": \"\",\n \"withholdingPercent\": \"\",\n \"receiverActivityCode\": \"\",\n \"idDocumentType\": \"\",\n \"socialSecurity\": \"\",\n \"colombiaEpsCode\": \"\",\n \"allowOrderWithoutDocumentControl\": \"\",\n \"defaultLoyaltyWalletId\": \"\",\n \"directDebitMandateAttachmentId\": \"\",\n \"customerPhotoAttachmentId\": \"\",\n \"noahId\": \"\",\n \"addresses\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"floor\": \"\",\n \"door\": \"\",\n \"building\": \"\",\n \"staircase\": \"\",\n \"apartment\": \"\",\n \"phone\": \"\",\n \"isBillingAddress\": \"\",\n \"isDefaultShippingAddress\": \"\"\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"floor\": \"\",\n \"door\": \"\",\n \"building\": \"\",\n \"staircase\": \"\",\n \"apartment\": \"\",\n \"phone\": \"\",\n \"isBillingAddress\": \"\",\n \"isDefaultShippingAddress\": \"\"\n }\n ],\n \"relationships\": [\n {\n \"id\": \"\",\n \"linkedCustomerId\": \"\",\n \"relationshipTypeId\": \"\",\n \"linkApp\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"contactSchedule\": \"\",\n \"contactPhone\": \"\",\n \"sharedLoyaltyWallets\": [\n {\n \"loyaltyWalletId\": \"\",\n \"shared\": \"\"\n },\n {\n \"loyaltyWalletId\": \"\",\n \"shared\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"linkedCustomerId\": \"\",\n \"relationshipTypeId\": \"\",\n \"linkApp\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"contactSchedule\": \"\",\n \"contactPhone\": \"\",\n \"sharedLoyaltyWallets\": [\n {\n \"loyaltyWalletId\": \"\",\n \"shared\": \"\"\n },\n {\n \"loyaltyWalletId\": \"\",\n \"shared\": \"\"\n }\n ]\n }\n ],\n \"accountingAccounts\": [\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"customerAccountId\": \"\",\n \"withholdingAccountId\": \"\",\n \"creditorAccountId\": \"\"\n },\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"customerAccountId\": \"\",\n \"withholdingAccountId\": \"\",\n \"creditorAccountId\": \"\"\n }\n ],\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"isCustomer\": \"\",\n \"isSupplier\": \"\",\n \"genericCounterparty\": \"\",\n \"counterpartyType\": \"G\",\n \"checkDigit\": \"\",\n \"taxIdUnvalidated\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"businessName\": \"\",\n \"taxId\": \"\",\n \"birthDate\": \"\",\n \"gender\": \"O\",\n \"maritalStatus\": \"SOLTERO\",\n \"profession\": \"\",\n \"blockType\": \"\",\n \"leadType\": \"LEAD\",\n \"neighbour\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"mobile\": \"\",\n \"phonePrefix\": \"\",\n \"fax\": \"\",\n \"website\": \"\",\n \"contactPerson\": \"\",\n \"contactSchedule\": \"\",\n \"position\": \"\",\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"countryCode\": \"\",\n \"billingAddressId\": \"\",\n \"shippingAddressId\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"customerProfileId\": \"\",\n \"associatedCompanyId\": \"\",\n \"lastWarehouseId\": \"\",\n \"lastEmployeeId\": \"\",\n \"bank\": \"\",\n \"checkingAccount\": \"\",\n \"iban\": \"\",\n \"bic\": \"\",\n \"sepaFormat\": \"CORE\",\n \"mandateSignDate\": \"\",\n \"sepaReference\": \"\",\n \"invoiceBalance\": \"\",\n \"baseRateId\": \"\",\n \"baseRateQuota\": \"\",\n \"discountRateId\": \"\",\n \"discountRateQuota\": \"\",\n \"discountPercent\": \"\",\n \"paymentTermsId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentDay1\": \"\",\n \"paymentDay2\": \"\",\n \"vatIndicator\": \"R\",\n \"assignedEmployeeId\": \"\",\n \"excludeFromLoyaltyPoints\": \"\",\n \"disability\": \"\",\n \"allowMarketing\": \"\",\n \"allowSurveys\": \"\",\n \"sendReminders\": \"\",\n \"sendSystemNotifications\": \"\",\n \"syncCrm\": \"\",\n \"lopdConsent\": \"\",\n \"feediuId\": \"\",\n \"sourceSystem\": \"\",\n \"observations\": \"\",\n \"documentObservations\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insurerDocumentLimit\": \"\",\n \"satTaxRegime\": \"\",\n \"withholdingAgent\": \"\",\n \"withholdingPercent\": \"\",\n \"receiverActivityCode\": \"\",\n \"idDocumentType\": \"\",\n \"socialSecurity\": \"\",\n \"colombiaEpsCode\": \"\",\n \"allowOrderWithoutDocumentControl\": \"\",\n \"defaultLoyaltyWalletId\": \"\",\n \"directDebitMandateAttachmentId\": \"\",\n \"customerPhotoAttachmentId\": \"\",\n \"noahId\": \"\",\n \"contacts\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"position\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"position\": \"\"\n }\n ],\n \"addresses\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"country\": \"\",\n \"countryName\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"floor\": \"\",\n \"door\": \"\",\n \"building\": \"\",\n \"staircase\": \"\",\n \"apartment\": \"\",\n \"phone\": \"\",\n \"isBillingAddress\": \"\",\n \"isDefaultShippingAddress\": \"\"\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"country\": \"\",\n \"countryName\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"floor\": \"\",\n \"door\": \"\",\n \"building\": \"\",\n \"staircase\": \"\",\n \"apartment\": \"\",\n \"phone\": \"\",\n \"isBillingAddress\": \"\",\n \"isDefaultShippingAddress\": \"\"\n }\n ],\n \"relationships\": [\n {\n \"id\": \"\",\n \"linkedCustomerId\": \"\",\n \"linkedCustomerDisplayName\": \"\",\n \"linkedCustomerPhone\": \"\",\n \"linkedCustomerLandline\": \"\",\n \"linkedCustomerEmail\": \"\",\n \"linkedCustomerBirthDate\": \"\",\n \"linkedCustomerAge\": \"\",\n \"relationshipTypeId\": \"\",\n \"relationshipTypeName\": \"\",\n \"linkApp\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"contactSchedule\": \"\",\n \"contactPhone\": \"\",\n \"sharedLoyaltyWallets\": [\n {\n \"loyaltyWalletId\": \"\",\n \"cardNumber\": \"\",\n \"customerCode\": \"\",\n \"cardLabel\": \"\",\n \"pointsBalance\": \"\",\n \"monetaryValue\": \"\",\n \"pointsDisplay\": \"\",\n \"shared\": \"\"\n },\n {\n \"loyaltyWalletId\": \"\",\n \"cardNumber\": \"\",\n \"customerCode\": \"\",\n \"cardLabel\": \"\",\n \"pointsBalance\": \"\",\n \"monetaryValue\": \"\",\n \"pointsDisplay\": \"\",\n \"shared\": \"\"\n }\n ],\n \"sharedLoyaltyWalletCount\": \"\"\n },\n {\n \"id\": \"\",\n \"linkedCustomerId\": \"\",\n \"linkedCustomerDisplayName\": \"\",\n \"linkedCustomerPhone\": \"\",\n \"linkedCustomerLandline\": \"\",\n \"linkedCustomerEmail\": \"\",\n \"linkedCustomerBirthDate\": \"\",\n \"linkedCustomerAge\": \"\",\n \"relationshipTypeId\": \"\",\n \"relationshipTypeName\": \"\",\n \"linkApp\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"contactSchedule\": \"\",\n \"contactPhone\": \"\",\n \"sharedLoyaltyWallets\": [\n {\n \"loyaltyWalletId\": \"\",\n \"cardNumber\": \"\",\n \"customerCode\": \"\",\n \"cardLabel\": \"\",\n \"pointsBalance\": \"\",\n \"monetaryValue\": \"\",\n \"pointsDisplay\": \"\",\n \"shared\": \"\"\n },\n {\n \"loyaltyWalletId\": \"\",\n \"cardNumber\": \"\",\n \"customerCode\": \"\",\n \"cardLabel\": \"\",\n \"pointsBalance\": \"\",\n \"monetaryValue\": \"\",\n \"pointsDisplay\": \"\",\n \"shared\": \"\"\n }\n ],\n \"sharedLoyaltyWalletCount\": \"\"\n }\n ],\n \"loyaltyWallets\": [\n {\n \"id\": \"\",\n \"cardNumber\": \"\",\n \"customerCode\": \"\",\n \"cardLabel\": \"\",\n \"pointsBalance\": \"\",\n \"monetaryValue\": \"\",\n \"pointsDisplay\": \"\"\n },\n {\n \"id\": \"\",\n \"cardNumber\": \"\",\n \"customerCode\": \"\",\n \"cardLabel\": \"\",\n \"pointsBalance\": \"\",\n \"monetaryValue\": \"\",\n \"pointsDisplay\": \"\"\n }\n ],\n \"accountingAccounts\": [\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"customerAccountId\": \"\",\n \"customerAccountCode\": \"\",\n \"withholdingAccountId\": \"\",\n \"withholdingAccountCode\": \"\",\n \"creditorAccountId\": \"\",\n \"creditorAccountCode\": \"\"\n },\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"customerAccountId\": \"\",\n \"customerAccountCode\": \"\",\n \"withholdingAccountId\": \"\",\n \"withholdingAccountCode\": \"\",\n \"creditorAccountId\": \"\",\n \"creditorAccountCode\": \"\"\n }\n ],\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"valueType\": \"\",\n \"value\": \"\",\n \"optionId\": \"\",\n \"optionLabel\": \"\",\n \"optionHex\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"valueType\": \"\",\n \"value\": \"\",\n \"optionId\": \"\",\n \"optionLabel\": \"\",\n \"optionHex\": \"\"\n }\n ],\n \"sapCode\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "702c28f4-9f1b-4264-b51f-74ac342bec38", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "customers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"isCustomer\": \"\",\n \"isSupplier\": \"\",\n \"genericCounterparty\": \"\",\n \"counterpartyType\": \"D\",\n \"checkDigit\": \"\",\n \"taxIdUnvalidated\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"businessName\": \"\",\n \"taxId\": \"\",\n \"birthDate\": \"\",\n \"gender\": \"H\",\n \"maritalStatus\": \"NODEFINIDO\",\n \"profession\": \"\",\n \"blockType\": \"\",\n \"leadType\": \"CL\",\n \"neighbour\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"mobile\": \"\",\n \"phonePrefix\": \"\",\n \"fax\": \"\",\n \"website\": \"\",\n \"contactPerson\": \"\",\n \"contactSchedule\": \"\",\n \"position\": \"\",\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"countryCode\": \"\",\n \"billingAddressId\": \"\",\n \"shippingAddressId\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"customerProfileId\": \"\",\n \"associatedCompanyId\": \"\",\n \"bank\": \"\",\n \"checkingAccount\": \"\",\n \"iban\": \"\",\n \"bic\": \"\",\n \"sepaFormat\": \"CORE\",\n \"mandateSignDate\": \"\",\n \"sepaReference\": \"\",\n \"baseRateId\": \"\",\n \"baseRateQuota\": \"\",\n \"discountRateId\": \"\",\n \"discountRateQuota\": \"\",\n \"discountPercent\": \"\",\n \"paymentTermsId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentDay1\": \"\",\n \"paymentDay2\": \"\",\n \"vatIndicator\": \"N\",\n \"assignedEmployeeId\": \"\",\n \"excludeFromLoyaltyPoints\": \"\",\n \"disability\": \"\",\n \"allowMarketing\": \"\",\n \"allowSurveys\": \"\",\n \"sendReminders\": \"\",\n \"sendSystemNotifications\": \"\",\n \"syncCrm\": \"\",\n \"lopdConsent\": \"\",\n \"feediuId\": \"\",\n \"sourceSystem\": \"\",\n \"observations\": \"\",\n \"documentObservations\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insurerDocumentLimit\": \"\",\n \"satTaxRegime\": \"\",\n \"withholdingAgent\": \"\",\n \"withholdingPercent\": \"\",\n \"receiverActivityCode\": \"\",\n \"idDocumentType\": \"\",\n \"socialSecurity\": \"\",\n \"colombiaEpsCode\": \"\",\n \"allowOrderWithoutDocumentControl\": \"\",\n \"defaultLoyaltyWalletId\": \"\",\n \"directDebitMandateAttachmentId\": \"\",\n \"customerPhotoAttachmentId\": \"\",\n \"noahId\": \"\",\n \"addresses\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"floor\": \"\",\n \"door\": \"\",\n \"building\": \"\",\n \"staircase\": \"\",\n \"apartment\": \"\",\n \"phone\": \"\",\n \"isBillingAddress\": \"\",\n \"isDefaultShippingAddress\": \"\"\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"floor\": \"\",\n \"door\": \"\",\n \"building\": \"\",\n \"staircase\": \"\",\n \"apartment\": \"\",\n \"phone\": \"\",\n \"isBillingAddress\": \"\",\n \"isDefaultShippingAddress\": \"\"\n }\n ],\n \"relationships\": [\n {\n \"id\": \"\",\n \"linkedCustomerId\": \"\",\n \"relationshipTypeId\": \"\",\n \"linkApp\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"contactSchedule\": \"\",\n \"contactPhone\": \"\",\n \"sharedLoyaltyWallets\": [\n {\n \"loyaltyWalletId\": \"\",\n \"shared\": \"\"\n },\n {\n \"loyaltyWalletId\": \"\",\n \"shared\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"linkedCustomerId\": \"\",\n \"relationshipTypeId\": \"\",\n \"linkApp\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"contactSchedule\": \"\",\n \"contactPhone\": \"\",\n \"sharedLoyaltyWallets\": [\n {\n \"loyaltyWalletId\": \"\",\n \"shared\": \"\"\n },\n {\n \"loyaltyWalletId\": \"\",\n \"shared\": \"\"\n }\n ]\n }\n ],\n \"accountingAccounts\": [\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"customerAccountId\": \"\",\n \"withholdingAccountId\": \"\",\n \"creditorAccountId\": \"\"\n },\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"customerAccountId\": \"\",\n \"withholdingAccountId\": \"\",\n \"creditorAccountId\": \"\"\n }\n ],\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1f58a2e6-2bd0-46f2-ac25-4a0f031e7c08", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "customers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"isCustomer\": \"\",\n \"isSupplier\": \"\",\n \"genericCounterparty\": \"\",\n \"counterpartyType\": \"D\",\n \"checkDigit\": \"\",\n \"taxIdUnvalidated\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"businessName\": \"\",\n \"taxId\": \"\",\n \"birthDate\": \"\",\n \"gender\": \"H\",\n \"maritalStatus\": \"NODEFINIDO\",\n \"profession\": \"\",\n \"blockType\": \"\",\n \"leadType\": \"CL\",\n \"neighbour\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"mobile\": \"\",\n \"phonePrefix\": \"\",\n \"fax\": \"\",\n \"website\": \"\",\n \"contactPerson\": \"\",\n \"contactSchedule\": \"\",\n \"position\": \"\",\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"countryCode\": \"\",\n \"billingAddressId\": \"\",\n \"shippingAddressId\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"customerProfileId\": \"\",\n \"associatedCompanyId\": \"\",\n \"bank\": \"\",\n \"checkingAccount\": \"\",\n \"iban\": \"\",\n \"bic\": \"\",\n \"sepaFormat\": \"CORE\",\n \"mandateSignDate\": \"\",\n \"sepaReference\": \"\",\n \"baseRateId\": \"\",\n \"baseRateQuota\": \"\",\n \"discountRateId\": \"\",\n \"discountRateQuota\": \"\",\n \"discountPercent\": \"\",\n \"paymentTermsId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentDay1\": \"\",\n \"paymentDay2\": \"\",\n \"vatIndicator\": \"N\",\n \"assignedEmployeeId\": \"\",\n \"excludeFromLoyaltyPoints\": \"\",\n \"disability\": \"\",\n \"allowMarketing\": \"\",\n \"allowSurveys\": \"\",\n \"sendReminders\": \"\",\n \"sendSystemNotifications\": \"\",\n \"syncCrm\": \"\",\n \"lopdConsent\": \"\",\n \"feediuId\": \"\",\n \"sourceSystem\": \"\",\n \"observations\": \"\",\n \"documentObservations\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insurerDocumentLimit\": \"\",\n \"satTaxRegime\": \"\",\n \"withholdingAgent\": \"\",\n \"withholdingPercent\": \"\",\n \"receiverActivityCode\": \"\",\n \"idDocumentType\": \"\",\n \"socialSecurity\": \"\",\n \"colombiaEpsCode\": \"\",\n \"allowOrderWithoutDocumentControl\": \"\",\n \"defaultLoyaltyWalletId\": \"\",\n \"directDebitMandateAttachmentId\": \"\",\n \"customerPhotoAttachmentId\": \"\",\n \"noahId\": \"\",\n \"addresses\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"floor\": \"\",\n \"door\": \"\",\n \"building\": \"\",\n \"staircase\": \"\",\n \"apartment\": \"\",\n \"phone\": \"\",\n \"isBillingAddress\": \"\",\n \"isDefaultShippingAddress\": \"\"\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"floor\": \"\",\n \"door\": \"\",\n \"building\": \"\",\n \"staircase\": \"\",\n \"apartment\": \"\",\n \"phone\": \"\",\n \"isBillingAddress\": \"\",\n \"isDefaultShippingAddress\": \"\"\n }\n ],\n \"relationships\": [\n {\n \"id\": \"\",\n \"linkedCustomerId\": \"\",\n \"relationshipTypeId\": \"\",\n \"linkApp\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"contactSchedule\": \"\",\n \"contactPhone\": \"\",\n \"sharedLoyaltyWallets\": [\n {\n \"loyaltyWalletId\": \"\",\n \"shared\": \"\"\n },\n {\n \"loyaltyWalletId\": \"\",\n \"shared\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"linkedCustomerId\": \"\",\n \"relationshipTypeId\": \"\",\n \"linkApp\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"contactSchedule\": \"\",\n \"contactPhone\": \"\",\n \"sharedLoyaltyWallets\": [\n {\n \"loyaltyWalletId\": \"\",\n \"shared\": \"\"\n },\n {\n \"loyaltyWalletId\": \"\",\n \"shared\": \"\"\n }\n ]\n }\n ],\n \"accountingAccounts\": [\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"customerAccountId\": \"\",\n \"withholdingAccountId\": \"\",\n \"creditorAccountId\": \"\"\n },\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"customerAccountId\": \"\",\n \"withholdingAccountId\": \"\",\n \"creditorAccountId\": \"\"\n }\n ],\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "39f53343-fee7-4be7-8e0f-de6dc2b944b1", "name": "Authenticated user is missing the `CREAR_CLIENTES` permission", "originalRequest": { "url": { "path": [ "api", "v2", "customers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"isCustomer\": \"\",\n \"isSupplier\": \"\",\n \"genericCounterparty\": \"\",\n \"counterpartyType\": \"D\",\n \"checkDigit\": \"\",\n \"taxIdUnvalidated\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"businessName\": \"\",\n \"taxId\": \"\",\n \"birthDate\": \"\",\n \"gender\": \"H\",\n \"maritalStatus\": \"NODEFINIDO\",\n \"profession\": \"\",\n \"blockType\": \"\",\n \"leadType\": \"CL\",\n \"neighbour\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"mobile\": \"\",\n \"phonePrefix\": \"\",\n \"fax\": \"\",\n \"website\": \"\",\n \"contactPerson\": \"\",\n \"contactSchedule\": \"\",\n \"position\": \"\",\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"countryCode\": \"\",\n \"billingAddressId\": \"\",\n \"shippingAddressId\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"customerProfileId\": \"\",\n \"associatedCompanyId\": \"\",\n \"bank\": \"\",\n \"checkingAccount\": \"\",\n \"iban\": \"\",\n \"bic\": \"\",\n \"sepaFormat\": \"CORE\",\n \"mandateSignDate\": \"\",\n \"sepaReference\": \"\",\n \"baseRateId\": \"\",\n \"baseRateQuota\": \"\",\n \"discountRateId\": \"\",\n \"discountRateQuota\": \"\",\n \"discountPercent\": \"\",\n \"paymentTermsId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentDay1\": \"\",\n \"paymentDay2\": \"\",\n \"vatIndicator\": \"N\",\n \"assignedEmployeeId\": \"\",\n \"excludeFromLoyaltyPoints\": \"\",\n \"disability\": \"\",\n \"allowMarketing\": \"\",\n \"allowSurveys\": \"\",\n \"sendReminders\": \"\",\n \"sendSystemNotifications\": \"\",\n \"syncCrm\": \"\",\n \"lopdConsent\": \"\",\n \"feediuId\": \"\",\n \"sourceSystem\": \"\",\n \"observations\": \"\",\n \"documentObservations\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insurerDocumentLimit\": \"\",\n \"satTaxRegime\": \"\",\n \"withholdingAgent\": \"\",\n \"withholdingPercent\": \"\",\n \"receiverActivityCode\": \"\",\n \"idDocumentType\": \"\",\n \"socialSecurity\": \"\",\n \"colombiaEpsCode\": \"\",\n \"allowOrderWithoutDocumentControl\": \"\",\n \"defaultLoyaltyWalletId\": \"\",\n \"directDebitMandateAttachmentId\": \"\",\n \"customerPhotoAttachmentId\": \"\",\n \"noahId\": \"\",\n \"addresses\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"floor\": \"\",\n \"door\": \"\",\n \"building\": \"\",\n \"staircase\": \"\",\n \"apartment\": \"\",\n \"phone\": \"\",\n \"isBillingAddress\": \"\",\n \"isDefaultShippingAddress\": \"\"\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"floor\": \"\",\n \"door\": \"\",\n \"building\": \"\",\n \"staircase\": \"\",\n \"apartment\": \"\",\n \"phone\": \"\",\n \"isBillingAddress\": \"\",\n \"isDefaultShippingAddress\": \"\"\n }\n ],\n \"relationships\": [\n {\n \"id\": \"\",\n \"linkedCustomerId\": \"\",\n \"relationshipTypeId\": \"\",\n \"linkApp\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"contactSchedule\": \"\",\n \"contactPhone\": \"\",\n \"sharedLoyaltyWallets\": [\n {\n \"loyaltyWalletId\": \"\",\n \"shared\": \"\"\n },\n {\n \"loyaltyWalletId\": \"\",\n \"shared\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"linkedCustomerId\": \"\",\n \"relationshipTypeId\": \"\",\n \"linkApp\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"contactSchedule\": \"\",\n \"contactPhone\": \"\",\n \"sharedLoyaltyWallets\": [\n {\n \"loyaltyWalletId\": \"\",\n \"shared\": \"\"\n },\n {\n \"loyaltyWalletId\": \"\",\n \"shared\": \"\"\n }\n ]\n }\n ],\n \"accountingAccounts\": [\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"customerAccountId\": \"\",\n \"withholdingAccountId\": \"\",\n \"creditorAccountId\": \"\"\n },\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"customerAccountId\": \"\",\n \"withholdingAccountId\": \"\",\n \"creditorAccountId\": \"\"\n }\n ],\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1e002417-a7d7-490d-bd8a-75025eeb90a6", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "customers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"isCustomer\": \"\",\n \"isSupplier\": \"\",\n \"genericCounterparty\": \"\",\n \"counterpartyType\": \"D\",\n \"checkDigit\": \"\",\n \"taxIdUnvalidated\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"businessName\": \"\",\n \"taxId\": \"\",\n \"birthDate\": \"\",\n \"gender\": \"H\",\n \"maritalStatus\": \"NODEFINIDO\",\n \"profession\": \"\",\n \"blockType\": \"\",\n \"leadType\": \"CL\",\n \"neighbour\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"mobile\": \"\",\n \"phonePrefix\": \"\",\n \"fax\": \"\",\n \"website\": \"\",\n \"contactPerson\": \"\",\n \"contactSchedule\": \"\",\n \"position\": \"\",\n \"billingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"shippingAddress\": {\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"apartment\": \"\"\n },\n \"countryCode\": \"\",\n \"billingAddressId\": \"\",\n \"shippingAddressId\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"customerProfileId\": \"\",\n \"associatedCompanyId\": \"\",\n \"bank\": \"\",\n \"checkingAccount\": \"\",\n \"iban\": \"\",\n \"bic\": \"\",\n \"sepaFormat\": \"CORE\",\n \"mandateSignDate\": \"\",\n \"sepaReference\": \"\",\n \"baseRateId\": \"\",\n \"baseRateQuota\": \"\",\n \"discountRateId\": \"\",\n \"discountRateQuota\": \"\",\n \"discountPercent\": \"\",\n \"paymentTermsId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentDay1\": \"\",\n \"paymentDay2\": \"\",\n \"vatIndicator\": \"N\",\n \"assignedEmployeeId\": \"\",\n \"excludeFromLoyaltyPoints\": \"\",\n \"disability\": \"\",\n \"allowMarketing\": \"\",\n \"allowSurveys\": \"\",\n \"sendReminders\": \"\",\n \"sendSystemNotifications\": \"\",\n \"syncCrm\": \"\",\n \"lopdConsent\": \"\",\n \"feediuId\": \"\",\n \"sourceSystem\": \"\",\n \"observations\": \"\",\n \"documentObservations\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"primaryInsurerId\": \"\",\n \"secondaryInsurerId\": \"\",\n \"tertiaryInsurerId\": \"\",\n \"primaryBeneficiaryNumber\": \"\",\n \"secondaryBeneficiaryNumber\": \"\",\n \"tertiaryBeneficiaryNumber\": \"\",\n \"insurerDocumentLimit\": \"\",\n \"satTaxRegime\": \"\",\n \"withholdingAgent\": \"\",\n \"withholdingPercent\": \"\",\n \"receiverActivityCode\": \"\",\n \"idDocumentType\": \"\",\n \"socialSecurity\": \"\",\n \"colombiaEpsCode\": \"\",\n \"allowOrderWithoutDocumentControl\": \"\",\n \"defaultLoyaltyWalletId\": \"\",\n \"directDebitMandateAttachmentId\": \"\",\n \"customerPhotoAttachmentId\": \"\",\n \"noahId\": \"\",\n \"addresses\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"floor\": \"\",\n \"door\": \"\",\n \"building\": \"\",\n \"staircase\": \"\",\n \"apartment\": \"\",\n \"phone\": \"\",\n \"isBillingAddress\": \"\",\n \"isDefaultShippingAddress\": \"\"\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"country\": \"\",\n \"province\": \"\",\n \"municipality\": \"\",\n \"locality\": \"\",\n \"postalCode\": \"\",\n \"streetType\": \"\",\n \"streetName\": \"\",\n \"streetNumber\": \"\",\n \"floor\": \"\",\n \"door\": \"\",\n \"building\": \"\",\n \"staircase\": \"\",\n \"apartment\": \"\",\n \"phone\": \"\",\n \"isBillingAddress\": \"\",\n \"isDefaultShippingAddress\": \"\"\n }\n ],\n \"relationships\": [\n {\n \"id\": \"\",\n \"linkedCustomerId\": \"\",\n \"relationshipTypeId\": \"\",\n \"linkApp\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"contactSchedule\": \"\",\n \"contactPhone\": \"\",\n \"sharedLoyaltyWallets\": [\n {\n \"loyaltyWalletId\": \"\",\n \"shared\": \"\"\n },\n {\n \"loyaltyWalletId\": \"\",\n \"shared\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"linkedCustomerId\": \"\",\n \"relationshipTypeId\": \"\",\n \"linkApp\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"contactSchedule\": \"\",\n \"contactPhone\": \"\",\n \"sharedLoyaltyWallets\": [\n {\n \"loyaltyWalletId\": \"\",\n \"shared\": \"\"\n },\n {\n \"loyaltyWalletId\": \"\",\n \"shared\": \"\"\n }\n ]\n }\n ],\n \"accountingAccounts\": [\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"customerAccountId\": \"\",\n \"withholdingAccountId\": \"\",\n \"creditorAccountId\": \"\"\n },\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"customerAccountId\": \"\",\n \"withholdingAccountId\": \"\",\n \"creditorAccountId\": \"\"\n }\n ],\n \"customFields\": [\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n },\n {\n \"customFieldId\": \"\",\n \"apiName\": \"\",\n \"value\": \"\",\n \"optionId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "customer-profiles", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "a1428597-2080-4023-a20c-aa0277b7914e", "name": "Get customer profile by ID", "request": { "name": "Get customer profile by ID", "description": { "content": "Returns a single customer profile by its primary key.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "customer-profiles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Customer profile ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "80f0a936-a1ba-43d4-8038-a877bf740162", "name": "Customer profile found", "originalRequest": { "url": { "path": [ "api", "v2", "customer-profiles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer profile ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"basePriceListId\": \"\",\n \"basePriceListName\": \"\",\n \"discountPriceListId\": \"\",\n \"discountPriceListName\": \"\",\n \"paymentTermsId\": \"\",\n \"paymentTermsName\": \"\",\n \"allowsCredit\": \"\",\n \"isInsurer\": \"\",\n \"isSupplier\": \"\",\n \"isCorporateDivision\": \"\",\n \"blockType\": \"\",\n \"notes\": [\n {\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"alert\": \"\",\n \"categoryKey\": \"\",\n \"categoryName\": \"\",\n \"categoryColor\": \"\",\n \"reminderAt\": \"\",\n \"ownerType\": \"customers\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n },\n {\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"alert\": \"\",\n \"categoryKey\": \"\",\n \"categoryName\": \"\",\n \"categoryColor\": \"\",\n \"reminderAt\": \"\",\n \"ownerType\": \"customer-profiles\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ae32c9e7-45ba-47d8-9150-995569bb4a55", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "customer-profiles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer profile ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6223e7f4-1031-4236-bd33-075fa1aba3bd", "name": "Authenticated user is missing the `VER_PERFILDECLIENTE` permission", "originalRequest": { "url": { "path": [ "api", "v2", "customer-profiles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer profile ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b58e734f-52f7-4e63-8be7-9312ecfa3484", "name": "Customer profile not found", "originalRequest": { "url": { "path": [ "api", "v2", "customer-profiles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer profile ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1d93b551-2d75-4472-b6e4-119289282045", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "customer-profiles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer profile ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "02692700-abf4-4828-be93-5a68af79d807", "name": "Update customer profile", "request": { "name": "Update customer profile", "description": { "content": "Full replacement of an existing customer profile. Send the `If-Match` header for optimistic concurrency (accepted but ignored ÔÇö not versioned).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "customer-profiles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Customer profile ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"paymentTermsId\": \"\",\n \"allowsCredit\": \"\",\n \"isInsurer\": \"\",\n \"isSupplier\": \"\",\n \"isCorporateDivision\": \"\",\n \"blockType\": \"\",\n \"notes\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"alert\": \"\",\n \"categoryKey\": \"\",\n \"reminderAt\": \"\",\n \"ownerType\": \"customer-profiles\",\n \"ownerId\": \"\",\n \"employeeId\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"alert\": \"\",\n \"categoryKey\": \"\",\n \"reminderAt\": \"\",\n \"ownerType\": \"customer-profiles\",\n \"ownerId\": \"\",\n \"employeeId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "c5fd01aa-c00b-4d66-aeae-cbda44ee271e", "name": "Customer profile updated", "originalRequest": { "url": { "path": [ "api", "v2", "customer-profiles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer profile ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"paymentTermsId\": \"\",\n \"allowsCredit\": \"\",\n \"isInsurer\": \"\",\n \"isSupplier\": \"\",\n \"isCorporateDivision\": \"\",\n \"blockType\": \"\",\n \"notes\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"alert\": \"\",\n \"categoryKey\": \"\",\n \"reminderAt\": \"\",\n \"ownerType\": \"customer-profiles\",\n \"ownerId\": \"\",\n \"employeeId\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"alert\": \"\",\n \"categoryKey\": \"\",\n \"reminderAt\": \"\",\n \"ownerType\": \"customer-profiles\",\n \"ownerId\": \"\",\n \"employeeId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"basePriceListId\": \"\",\n \"basePriceListName\": \"\",\n \"discountPriceListId\": \"\",\n \"discountPriceListName\": \"\",\n \"paymentTermsId\": \"\",\n \"paymentTermsName\": \"\",\n \"allowsCredit\": \"\",\n \"isInsurer\": \"\",\n \"isSupplier\": \"\",\n \"isCorporateDivision\": \"\",\n \"blockType\": \"\",\n \"notes\": [\n {\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"alert\": \"\",\n \"categoryKey\": \"\",\n \"categoryName\": \"\",\n \"categoryColor\": \"\",\n \"reminderAt\": \"\",\n \"ownerType\": \"customers\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n },\n {\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"alert\": \"\",\n \"categoryKey\": \"\",\n \"categoryName\": \"\",\n \"categoryColor\": \"\",\n \"reminderAt\": \"\",\n \"ownerType\": \"customer-profiles\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c43fac9f-3929-459e-9d58-c322c6b3c1ec", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "customer-profiles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer profile ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"paymentTermsId\": \"\",\n \"allowsCredit\": \"\",\n \"isInsurer\": \"\",\n \"isSupplier\": \"\",\n \"isCorporateDivision\": \"\",\n \"blockType\": \"\",\n \"notes\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"alert\": \"\",\n \"categoryKey\": \"\",\n \"reminderAt\": \"\",\n \"ownerType\": \"customer-profiles\",\n \"ownerId\": \"\",\n \"employeeId\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"alert\": \"\",\n \"categoryKey\": \"\",\n \"reminderAt\": \"\",\n \"ownerType\": \"customer-profiles\",\n \"ownerId\": \"\",\n \"employeeId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e52da7f5-b035-4fca-a81d-4f4340feaa29", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "customer-profiles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer profile ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"paymentTermsId\": \"\",\n \"allowsCredit\": \"\",\n \"isInsurer\": \"\",\n \"isSupplier\": \"\",\n \"isCorporateDivision\": \"\",\n \"blockType\": \"\",\n \"notes\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"alert\": \"\",\n \"categoryKey\": \"\",\n \"reminderAt\": \"\",\n \"ownerType\": \"customer-profiles\",\n \"ownerId\": \"\",\n \"employeeId\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"alert\": \"\",\n \"categoryKey\": \"\",\n \"reminderAt\": \"\",\n \"ownerType\": \"customer-profiles\",\n \"ownerId\": \"\",\n \"employeeId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "88950770-69ec-4f7e-b02a-6c304ecdfb26", "name": "Authenticated user is missing the `EDITAR_PERFILDECLIENTE` permission", "originalRequest": { "url": { "path": [ "api", "v2", "customer-profiles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer profile ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"paymentTermsId\": \"\",\n \"allowsCredit\": \"\",\n \"isInsurer\": \"\",\n \"isSupplier\": \"\",\n \"isCorporateDivision\": \"\",\n \"blockType\": \"\",\n \"notes\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"alert\": \"\",\n \"categoryKey\": \"\",\n \"reminderAt\": \"\",\n \"ownerType\": \"customer-profiles\",\n \"ownerId\": \"\",\n \"employeeId\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"alert\": \"\",\n \"categoryKey\": \"\",\n \"reminderAt\": \"\",\n \"ownerType\": \"customer-profiles\",\n \"ownerId\": \"\",\n \"employeeId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f94282ea-df28-46b5-8482-fbd24efb680f", "name": "Customer profile not found", "originalRequest": { "url": { "path": [ "api", "v2", "customer-profiles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer profile ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"paymentTermsId\": \"\",\n \"allowsCredit\": \"\",\n \"isInsurer\": \"\",\n \"isSupplier\": \"\",\n \"isCorporateDivision\": \"\",\n \"blockType\": \"\",\n \"notes\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"alert\": \"\",\n \"categoryKey\": \"\",\n \"reminderAt\": \"\",\n \"ownerType\": \"customer-profiles\",\n \"ownerId\": \"\",\n \"employeeId\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"alert\": \"\",\n \"categoryKey\": \"\",\n \"reminderAt\": \"\",\n \"ownerType\": \"customer-profiles\",\n \"ownerId\": \"\",\n \"employeeId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "be3c37d1-ca57-4188-9b2a-93ec10668470", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "customer-profiles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer profile ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"paymentTermsId\": \"\",\n \"allowsCredit\": \"\",\n \"isInsurer\": \"\",\n \"isSupplier\": \"\",\n \"isCorporateDivision\": \"\",\n \"blockType\": \"\",\n \"notes\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"alert\": \"\",\n \"categoryKey\": \"\",\n \"reminderAt\": \"\",\n \"ownerType\": \"customer-profiles\",\n \"ownerId\": \"\",\n \"employeeId\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"alert\": \"\",\n \"categoryKey\": \"\",\n \"reminderAt\": \"\",\n \"ownerType\": \"customer-profiles\",\n \"ownerId\": \"\",\n \"employeeId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "aebc314d-7658-4a09-a336-564bc7490148", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "customer-profiles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer profile ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"paymentTermsId\": \"\",\n \"allowsCredit\": \"\",\n \"isInsurer\": \"\",\n \"isSupplier\": \"\",\n \"isCorporateDivision\": \"\",\n \"blockType\": \"\",\n \"notes\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"alert\": \"\",\n \"categoryKey\": \"\",\n \"reminderAt\": \"\",\n \"ownerType\": \"customer-profiles\",\n \"ownerId\": \"\",\n \"employeeId\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"alert\": \"\",\n \"categoryKey\": \"\",\n \"reminderAt\": \"\",\n \"ownerType\": \"customer-profiles\",\n \"ownerId\": \"\",\n \"employeeId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "16106081-0a1c-41b8-b0f1-97e6ddbe9009", "name": "Delete customer profile", "request": { "name": "Delete customer profile", "description": { "content": "Deletes a customer profile. Send the `If-Match` header with the current ETag (accepted but ignored ÔÇö not versioned).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "customer-profiles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Customer profile ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "699c1bab-49f3-44a2-9aa8-82559c7f246c", "name": "Customer profile deleted", "originalRequest": { "url": { "path": [ "api", "v2", "customer-profiles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer profile ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "82d40141-e610-4528-baf8-0ad87b972c46", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "customer-profiles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer profile ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6a97fda3-4bfa-4537-a7b7-f8e2c33446d3", "name": "Authenticated user is missing the `BORRAR_PERFILDECLIENTE` permission", "originalRequest": { "url": { "path": [ "api", "v2", "customer-profiles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer profile ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ae9b29c8-c916-4f5a-9512-df0f008cb655", "name": "Customer profile not found", "originalRequest": { "url": { "path": [ "api", "v2", "customer-profiles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer profile ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "36fe6da9-be74-44d7-ace7-0578677a1ef2", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "customer-profiles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer profile ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "42563ff0-affd-4c32-a7fa-9dc9ad1410ae", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "customer-profiles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer profile ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "26022dd2-cd1b-452e-92bf-d7835cbcab8e", "name": "Merge-patch customer profile", "request": { "name": "Merge-patch customer profile", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "customer-profiles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Customer profile ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "7e266c92-9141-4546-b6fc-42252b3416f1", "name": "Customer profile patched", "originalRequest": { "url": { "path": [ "api", "v2", "customer-profiles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer profile ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"basePriceListId\": \"\",\n \"basePriceListName\": \"\",\n \"discountPriceListId\": \"\",\n \"discountPriceListName\": \"\",\n \"paymentTermsId\": \"\",\n \"paymentTermsName\": \"\",\n \"allowsCredit\": \"\",\n \"isInsurer\": \"\",\n \"isSupplier\": \"\",\n \"isCorporateDivision\": \"\",\n \"blockType\": \"\",\n \"notes\": [\n {\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"alert\": \"\",\n \"categoryKey\": \"\",\n \"categoryName\": \"\",\n \"categoryColor\": \"\",\n \"reminderAt\": \"\",\n \"ownerType\": \"customers\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n },\n {\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"alert\": \"\",\n \"categoryKey\": \"\",\n \"categoryName\": \"\",\n \"categoryColor\": \"\",\n \"reminderAt\": \"\",\n \"ownerType\": \"customer-profiles\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2b07df67-04c0-4848-a24c-5440c4969b38", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "customer-profiles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer profile ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d798df7e-5561-4b5a-97d3-365bf5bbdc59", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "customer-profiles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer profile ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "44447763-4fd5-487d-96a9-b3fe6f95c636", "name": "Authenticated user is missing the `EDITAR_PERFILDECLIENTE` permission", "originalRequest": { "url": { "path": [ "api", "v2", "customer-profiles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer profile ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "88eecbdc-00c5-42e2-865c-d310bec7d88b", "name": "Customer profile not found", "originalRequest": { "url": { "path": [ "api", "v2", "customer-profiles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer profile ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b78c9300-a7e9-466b-8212-c07e6b084bb3", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "customer-profiles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer profile ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8a83ec6b-28ca-446d-9070-e922d05617ab", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "customer-profiles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer profile ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "eafebec4-e023-48f4-8caf-da27a649a5ed", "name": "List customer profiles", "request": { "name": "List customer profiles", "description": { "content": "Returns a paginated list of customer profiles with envelope `{data, totalCount, skip, limit, hasMore}`. Supports optional RSQL `filter`, `sort` (default `name:asc`), `skip`/`limit` pagination and `modifiedAfter`/`modifiedBefore` bookends.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "customer-profiles" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "c0d68e7e-85a1-4833-afaf-bb1326035027", "name": "Page of customer profiles", "originalRequest": { "url": { "path": [ "api", "v2", "customer-profiles" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3afa8b2c-ef5a-49c6-920c-a3d7e0ecf01c", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "customer-profiles" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a9feb73f-587c-4c4a-95cc-ad9e00e37318", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "customer-profiles" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ea616ddf-6a4c-4563-b033-da5ac9636b1b", "name": "Authenticated user is missing the `VER_PERFILDECLIENTE` permission", "originalRequest": { "url": { "path": [ "api", "v2", "customer-profiles" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d7957282-0bbc-4902-aa84-cc335294802d", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "customer-profiles" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9a4a5601-023e-4946-9fb7-4695731d8b60", "name": "Create customer profile", "request": { "name": "Create customer profile", "description": { "content": "Creates a new customer profile. Business logic runs in the legacy WAR.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "customer-profiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"paymentTermsId\": \"\",\n \"allowsCredit\": \"\",\n \"isInsurer\": \"\",\n \"isSupplier\": \"\",\n \"isCorporateDivision\": \"\",\n \"blockType\": \"\",\n \"notes\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"alert\": \"\",\n \"categoryKey\": \"\",\n \"reminderAt\": \"\",\n \"ownerType\": \"customer-profiles\",\n \"ownerId\": \"\",\n \"employeeId\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"alert\": \"\",\n \"categoryKey\": \"\",\n \"reminderAt\": \"\",\n \"ownerType\": \"customer-profiles\",\n \"ownerId\": \"\",\n \"employeeId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "267e4bb1-18cb-4b18-a64a-92d3c89c1939", "name": "Customer profile created", "originalRequest": { "url": { "path": [ "api", "v2", "customer-profiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"paymentTermsId\": \"\",\n \"allowsCredit\": \"\",\n \"isInsurer\": \"\",\n \"isSupplier\": \"\",\n \"isCorporateDivision\": \"\",\n \"blockType\": \"\",\n \"notes\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"alert\": \"\",\n \"categoryKey\": \"\",\n \"reminderAt\": \"\",\n \"ownerType\": \"customer-profiles\",\n \"ownerId\": \"\",\n \"employeeId\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"alert\": \"\",\n \"categoryKey\": \"\",\n \"reminderAt\": \"\",\n \"ownerType\": \"customer-profiles\",\n \"ownerId\": \"\",\n \"employeeId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"basePriceListId\": \"\",\n \"basePriceListName\": \"\",\n \"discountPriceListId\": \"\",\n \"discountPriceListName\": \"\",\n \"paymentTermsId\": \"\",\n \"paymentTermsName\": \"\",\n \"allowsCredit\": \"\",\n \"isInsurer\": \"\",\n \"isSupplier\": \"\",\n \"isCorporateDivision\": \"\",\n \"blockType\": \"\",\n \"notes\": [\n {\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"alert\": \"\",\n \"categoryKey\": \"\",\n \"categoryName\": \"\",\n \"categoryColor\": \"\",\n \"reminderAt\": \"\",\n \"ownerType\": \"customers\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n },\n {\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"alert\": \"\",\n \"categoryKey\": \"\",\n \"categoryName\": \"\",\n \"categoryColor\": \"\",\n \"reminderAt\": \"\",\n \"ownerType\": \"customer-profiles\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "118099bb-0cb0-4b08-95e8-d1ce1e670adb", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "customer-profiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"paymentTermsId\": \"\",\n \"allowsCredit\": \"\",\n \"isInsurer\": \"\",\n \"isSupplier\": \"\",\n \"isCorporateDivision\": \"\",\n \"blockType\": \"\",\n \"notes\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"alert\": \"\",\n \"categoryKey\": \"\",\n \"reminderAt\": \"\",\n \"ownerType\": \"customer-profiles\",\n \"ownerId\": \"\",\n \"employeeId\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"alert\": \"\",\n \"categoryKey\": \"\",\n \"reminderAt\": \"\",\n \"ownerType\": \"customer-profiles\",\n \"ownerId\": \"\",\n \"employeeId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "68b486e2-81ab-4bf5-9444-6fd69983848c", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "customer-profiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"paymentTermsId\": \"\",\n \"allowsCredit\": \"\",\n \"isInsurer\": \"\",\n \"isSupplier\": \"\",\n \"isCorporateDivision\": \"\",\n \"blockType\": \"\",\n \"notes\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"alert\": \"\",\n \"categoryKey\": \"\",\n \"reminderAt\": \"\",\n \"ownerType\": \"customer-profiles\",\n \"ownerId\": \"\",\n \"employeeId\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"alert\": \"\",\n \"categoryKey\": \"\",\n \"reminderAt\": \"\",\n \"ownerType\": \"customer-profiles\",\n \"ownerId\": \"\",\n \"employeeId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4af90cf9-a6e1-480f-a598-3ac3f13b0666", "name": "Authenticated user is missing the `CREAR_PERFILDECLIENTE` permission", "originalRequest": { "url": { "path": [ "api", "v2", "customer-profiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"paymentTermsId\": \"\",\n \"allowsCredit\": \"\",\n \"isInsurer\": \"\",\n \"isSupplier\": \"\",\n \"isCorporateDivision\": \"\",\n \"blockType\": \"\",\n \"notes\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"alert\": \"\",\n \"categoryKey\": \"\",\n \"reminderAt\": \"\",\n \"ownerType\": \"customer-profiles\",\n \"ownerId\": \"\",\n \"employeeId\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"alert\": \"\",\n \"categoryKey\": \"\",\n \"reminderAt\": \"\",\n \"ownerType\": \"customer-profiles\",\n \"ownerId\": \"\",\n \"employeeId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e02e2809-e6a6-4dea-80c1-db59117118a1", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "customer-profiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"paymentTermsId\": \"\",\n \"allowsCredit\": \"\",\n \"isInsurer\": \"\",\n \"isSupplier\": \"\",\n \"isCorporateDivision\": \"\",\n \"blockType\": \"\",\n \"notes\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"alert\": \"\",\n \"categoryKey\": \"\",\n \"reminderAt\": \"\",\n \"ownerType\": \"customer-profiles\",\n \"ownerId\": \"\",\n \"employeeId\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"alert\": \"\",\n \"categoryKey\": \"\",\n \"reminderAt\": \"\",\n \"ownerType\": \"customer-profiles\",\n \"ownerId\": \"\",\n \"employeeId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2da0d50b-b040-487f-8b43-93d3236ba61d", "name": "Bulk delete customer profiles", "request": { "name": "Bulk delete customer profiles", "description": { "content": "Removes every id in `ids` as a single all-or-nothing transaction.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "customer-profiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "74dd127c-7572-4070-837a-6dba897b2cab", "name": "All entities deleted", "originalRequest": { "url": { "path": [ "api", "v2", "customer-profiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"deleted\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3b782435-5d88-4cbf-9012-325b60cf3316", "name": "Empty `ids` or unknown id", "originalRequest": { "url": { "path": [ "api", "v2", "customer-profiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0e01cefb-1844-4f90-8958-f5016f187225", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "customer-profiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1d4519f4-7e1f-44db-83e9-cb9a5c264afc", "name": "Authenticated user is missing the `BORRAR_PERFILDECLIENTE` permission", "originalRequest": { "url": { "path": [ "api", "v2", "customer-profiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "10983046-4ba7-4bc1-8e9a-0ae06f5e7f75", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "customer-profiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b1604f42-636f-48fb-a6e3-9ea450a114c5", "name": "Bulk patch customer profiles", "request": { "name": "Bulk patch customer profiles", "description": { "content": "Applies the same `patch` to every id in `ids` as a single all-or-nothing transaction. Editable fields: `enabled`, `allowsCredit`, `isInsurer`, `isSupplier`, `isCorporateDivision`.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "customer-profiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"patch\": {\n \"key_0\": \"string\",\n \"key_1\": 4074,\n \"key_2\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "4decbbcc-5a7c-4eb1-bcbd-cea9d525541d", "name": "All entities updated", "originalRequest": { "url": { "path": [ "api", "v2", "customer-profiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"patch\": {\n \"key_0\": \"string\",\n \"key_1\": 4074,\n \"key_2\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"updated\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "484d1e68-a3fe-4599-b618-68898fe1933e", "name": "Empty `ids`/`patch`, malformed payload or non-whitelisted field", "originalRequest": { "url": { "path": [ "api", "v2", "customer-profiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"patch\": {\n \"key_0\": \"string\",\n \"key_1\": 4074,\n \"key_2\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bfee9041-eb4d-474f-a52a-b477c43dd52e", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "customer-profiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"patch\": {\n \"key_0\": \"string\",\n \"key_1\": 4074,\n \"key_2\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "55ef792e-c608-4fed-b162-79d5deded3e2", "name": "Authenticated user is missing the `EDITAR_PERFILDECLIENTE` permission", "originalRequest": { "url": { "path": [ "api", "v2", "customer-profiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"patch\": {\n \"key_0\": \"string\",\n \"key_1\": 4074,\n \"key_2\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a257f8bb-6442-42fd-909e-c39cc34ef875", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "customer-profiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"patch\": {\n \"key_0\": \"string\",\n \"key_1\": 4074,\n \"key_2\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "new", "description": "", "item": [ { "id": "054e304a-c002-477c-a06c-74e5ab95f273", "name": "Prototype customer profile for a creation form", "request": { "name": "Prototype customer profile for a creation form", "description": { "content": "Returns a non-persisted customer profile pre-populated with backend defaults (`enabled=true`, current company, next `code`, empty `name`). Optional JSON hints: `companyId`, `copyFromId`. Call `POST /api/v2/customer-profiles` afterwards to persist.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "customer-profiles", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "27cc71ad-01c6-4b1e-81e0-a6941b5b0f43", "name": "Customer profile prototype with defaults", "originalRequest": { "url": { "path": [ "api", "v2", "customer-profiles", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"basePriceListId\": \"\",\n \"basePriceListName\": \"\",\n \"discountPriceListId\": \"\",\n \"discountPriceListName\": \"\",\n \"paymentTermsId\": \"\",\n \"paymentTermsName\": \"\",\n \"allowsCredit\": \"\",\n \"isInsurer\": \"\",\n \"isSupplier\": \"\",\n \"isCorporateDivision\": \"\",\n \"blockType\": \"\",\n \"notes\": [\n {\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"alert\": \"\",\n \"categoryKey\": \"\",\n \"categoryName\": \"\",\n \"categoryColor\": \"\",\n \"reminderAt\": \"\",\n \"ownerType\": \"customers\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n },\n {\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"alert\": \"\",\n \"categoryKey\": \"\",\n \"categoryName\": \"\",\n \"categoryColor\": \"\",\n \"reminderAt\": \"\",\n \"ownerType\": \"customer-profiles\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5ed71781-4755-48be-9b3b-7f3fe0f325be", "name": "Invalid prepare-create hints", "originalRequest": { "url": { "path": [ "api", "v2", "customer-profiles", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "82dea0d3-0fae-47c0-820f-cc45bae11394", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "customer-profiles", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "758b9df7-6d1c-45d3-bc3e-ebed2219c2a2", "name": "Authenticated user is missing the `CREAR_PERFILDECLIENTE` permission", "originalRequest": { "url": { "path": [ "api", "v2", "customer-profiles", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f6d13c20-c547-4030-a48e-282e298ac431", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "customer-profiles", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "custom-field-definitions", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "6f29a9bb-66a3-4bcb-aad2-ba6ab95bb7b6", "name": "Get custom field definition by ID", "request": { "name": "Get custom field definition by ID", "description": { "content": "Returns a single definition by its primary key (enabled or not). The response carries a strong `ETag` header with the current version. For EAV-backed featureTypes (product-models, product-variants, manufacturing-custom-fields) the `featureType` query parameter is required to select the ges_customfield id namespace; no ETag is emitted for them.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "custom-field-definitions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "6f5223bd-beeb-4e19-a31b-5532dec2d6cd", "name": "Custom field definition found", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"featureType\": \"\",\n \"apiName\": \"\",\n \"dataType\": \"\",\n \"label\": \"\",\n \"required\": \"\",\n \"indexable\": \"\",\n \"optionCount\": \"\",\n \"displayOrder\": \"\",\n \"displayGroup\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cd00e6f8-f70e-4df1-bf94-accf6c3af6e6", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bb8d1bfe-e2c0-456d-b424-7894771f9616", "name": "Authenticated user is missing the `VER_CAMPOSPERSONALIZADOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f769ec61-ccf6-4e3c-9ec4-f9e0ee598130", "name": "Custom field definition not found", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5bb92156-fd32-40e0-804b-b963a43005b3", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2264ccb0-2357-4f97-ad98-66b6106428dd", "name": "Update custom field definition", "request": { "name": "Update custom field definition", "description": { "content": "Full replacement of an existing definition. `featureType` and `dataType` are immutable (stored values keyed by the id would stop matching); renaming `apiName`/`label` is always safe. `options` is rejected here: manage options through the `/options` sub-resource. Send the `If-Match` header with the current ETag for optimistic concurrency control. For EAV-backed featureTypes pass the `featureType` query parameter (If-Match is ignored for them).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "custom-field-definitions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"featureType\": \"\",\n \"apiName\": \"\",\n \"dataType\": \"\",\n \"label\": \"\",\n \"required\": \"\",\n \"indexable\": \"\",\n \"options\": [\n \"\",\n \"\"\n ],\n \"displayOrder\": \"\",\n \"displayGroup\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "e07ba3c1-05a9-4229-9940-863a2ccc64ae", "name": "Custom field definition updated", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"featureType\": \"\",\n \"apiName\": \"\",\n \"dataType\": \"\",\n \"label\": \"\",\n \"required\": \"\",\n \"indexable\": \"\",\n \"options\": [\n \"\",\n \"\"\n ],\n \"displayOrder\": \"\",\n \"displayGroup\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"featureType\": \"\",\n \"apiName\": \"\",\n \"dataType\": \"\",\n \"label\": \"\",\n \"required\": \"\",\n \"indexable\": \"\",\n \"optionCount\": \"\",\n \"displayOrder\": \"\",\n \"displayGroup\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7a44fa4f-2054-4fa4-8db6-ae60f87f5dcb", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"featureType\": \"\",\n \"apiName\": \"\",\n \"dataType\": \"\",\n \"label\": \"\",\n \"required\": \"\",\n \"indexable\": \"\",\n \"options\": [\n \"\",\n \"\"\n ],\n \"displayOrder\": \"\",\n \"displayGroup\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2f27d121-3f8b-4ed1-9bde-891b541d5b59", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"featureType\": \"\",\n \"apiName\": \"\",\n \"dataType\": \"\",\n \"label\": \"\",\n \"required\": \"\",\n \"indexable\": \"\",\n \"options\": [\n \"\",\n \"\"\n ],\n \"displayOrder\": \"\",\n \"displayGroup\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ecf52d6b-046d-45b2-81e4-a1403643edd0", "name": "Authenticated user is missing the `EDITAR_CAMPOSPERSONALIZADOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"featureType\": \"\",\n \"apiName\": \"\",\n \"dataType\": \"\",\n \"label\": \"\",\n \"required\": \"\",\n \"indexable\": \"\",\n \"options\": [\n \"\",\n \"\"\n ],\n \"displayOrder\": \"\",\n \"displayGroup\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c8ac59b5-5249-48e9-ad67-422b78f78133", "name": "Custom field definition not found", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"featureType\": \"\",\n \"apiName\": \"\",\n \"dataType\": \"\",\n \"label\": \"\",\n \"required\": \"\",\n \"indexable\": \"\",\n \"options\": [\n \"\",\n \"\"\n ],\n \"displayOrder\": \"\",\n \"displayGroup\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "706fa1b7-227b-4f76-b97f-37e7bee2e8aa", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"featureType\": \"\",\n \"apiName\": \"\",\n \"dataType\": \"\",\n \"label\": \"\",\n \"required\": \"\",\n \"indexable\": \"\",\n \"options\": [\n \"\",\n \"\"\n ],\n \"displayOrder\": \"\",\n \"displayGroup\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0d13a2b2-78c8-4b06-8689-ee2a037ede64", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"featureType\": \"\",\n \"apiName\": \"\",\n \"dataType\": \"\",\n \"label\": \"\",\n \"required\": \"\",\n \"indexable\": \"\",\n \"options\": [\n \"\",\n \"\"\n ],\n \"displayOrder\": \"\",\n \"displayGroup\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "afa6cc8d-d0c4-4b8a-abd4-0e113f9f073c", "name": "Delete custom field definition", "request": { "name": "Delete custom field definition", "description": { "content": "Deletes a definition. Stored JSON values keyed by this id are left in place and ignored by readers (prefer disabling via `enabled=false` when the data should stay recoverable). Send the `If-Match` header with the current ETag for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "custom-field-definitions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "3c8467fd-d2e9-41a0-b1de-571234d67d9c", "name": "Custom field definition deleted", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "df14eef6-ed26-4b4d-a2d6-6fb2a714d3e0", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "44634a1a-31df-41e2-a8e7-ce715a3a2eea", "name": "Authenticated user is missing the `BORRAR_CAMPOSPERSONALIZADOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5257bc85-0586-4b44-bb58-926a8ebbe6f7", "name": "Custom field definition not found", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "799a3393-aa0c-4ce1-9d56-31254c3803eb", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fb41d02a-ca57-4ae6-9a87-07ab525d982a", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3c1c3979-1938-496d-a47c-d6213d9c6bdf", "name": "Merge-patch custom field definition", "request": { "name": "Merge-patch custom field definition", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "custom-field-definitions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "ea5d3ba3-96d7-4a85-8aba-038d31865e85", "name": "Custom field definition patched", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"featureType\": \"\",\n \"apiName\": \"\",\n \"dataType\": \"\",\n \"label\": \"\",\n \"required\": \"\",\n \"indexable\": \"\",\n \"optionCount\": \"\",\n \"displayOrder\": \"\",\n \"displayGroup\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d98e71f3-3972-48cf-8476-de5fc2fb3fb5", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details. Also returned for malformed merge-patch payloads.", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b603eabc-d3ee-45c0-b28f-3341be8fddad", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4d7cafc4-9b85-46b1-9c10-5e6f423574d7", "name": "Authenticated user is missing the `EDITAR_CAMPOSPERSONALIZADOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "66b930cd-d99e-4ded-a19b-e2bc2f8015de", "name": "Custom field definition not found", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "060d267a-0b50-4ce7-bb69-3e5c021a3a79", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "45e5bf01-48c9-44eb-a78f-6969aa3a2ff3", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "{definitionId}", "description": "", "item": [ { "name": "options", "description": "", "item": [ { "name": "{optionId}", "description": "", "item": [ { "id": "8e487ca7-fc38-40fa-8794-fc81a7fa4449", "name": "Get option by ID", "request": { "name": "Get option by ID", "description": { "content": "Returns a single option (enabled or not). The response carries a strong `ETag` header with the current version.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "custom-field-definitions", ":definitionId", "options", ":optionId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "definitionId", "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" } }, { "type": "any", "value": "", "key": "optionId", "disabled": false, "description": { "content": "(Required) Option ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "d75fde45-4fcf-44db-8ada-926119345423", "name": "Option found", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":definitionId", "options", ":optionId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "definitionId" }, { "disabled": false, "description": { "content": "(Required) Option ID", "type": "text/plain" }, "type": "any", "value": "", "key": "optionId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"customFieldDefinitionId\": \"\",\n \"value\": \"\",\n \"displayOrder\": \"\",\n \"hex\": \"\",\n \"enabled\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "020172f9-aa0f-46b9-a5f7-3786c601b7a8", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":definitionId", "options", ":optionId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "definitionId" }, { "disabled": false, "description": { "content": "(Required) Option ID", "type": "text/plain" }, "type": "any", "value": "", "key": "optionId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cac15830-6b29-4ba0-9f53-179f4262ba36", "name": "Authenticated user is missing the `VER_CAMPOSPERSONALIZADOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":definitionId", "options", ":optionId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "definitionId" }, { "disabled": false, "description": { "content": "(Required) Option ID", "type": "text/plain" }, "type": "any", "value": "", "key": "optionId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b804c632-8be1-42ea-872f-ce73b915850f", "name": "Option not found for this definition", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":definitionId", "options", ":optionId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "definitionId" }, { "disabled": false, "description": { "content": "(Required) Option ID", "type": "text/plain" }, "type": "any", "value": "", "key": "optionId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "12fb375a-9567-48f3-a3b6-9a1f832cd3a0", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":definitionId", "options", ":optionId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "definitionId" }, { "disabled": false, "description": { "content": "(Required) Option ID", "type": "text/plain" }, "type": "any", "value": "", "key": "optionId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "26d1cf3d-7970-4e6b-8c7a-8aa95a5dd73f", "name": "Update option", "request": { "name": "Update option", "description": { "content": "Full replacement (value, displayOrder, enabled). Renaming `value` does NOT rewrite previously stored entity values (they keep the old label and stop matching any option); prefer disabling the old option and creating a new one when the meaning changes. Send the `If-Match` header with the current ETag for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "custom-field-definitions", ":definitionId", "options", ":optionId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "definitionId", "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" } }, { "type": "any", "value": "", "key": "optionId", "disabled": false, "description": { "content": "(Required) Option ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"value\": \"\",\n \"displayOrder\": \"\",\n \"hex\": \"\",\n \"enabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "5e63eef4-0891-4b50-8ec0-0a8bd6ada3c8", "name": "Option updated", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":definitionId", "options", ":optionId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "definitionId" }, { "disabled": false, "description": { "content": "(Required) Option ID", "type": "text/plain" }, "type": "any", "value": "", "key": "optionId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"value\": \"\",\n \"displayOrder\": \"\",\n \"hex\": \"\",\n \"enabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"customFieldDefinitionId\": \"\",\n \"value\": \"\",\n \"displayOrder\": \"\",\n \"hex\": \"\",\n \"enabled\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3ae16539-8889-4171-80a8-ff67c8a2fa02", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":definitionId", "options", ":optionId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "definitionId" }, { "disabled": false, "description": { "content": "(Required) Option ID", "type": "text/plain" }, "type": "any", "value": "", "key": "optionId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"value\": \"\",\n \"displayOrder\": \"\",\n \"hex\": \"\",\n \"enabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "269a36be-b91b-46d3-a8f5-045395a12eb3", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":definitionId", "options", ":optionId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "definitionId" }, { "disabled": false, "description": { "content": "(Required) Option ID", "type": "text/plain" }, "type": "any", "value": "", "key": "optionId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"value\": \"\",\n \"displayOrder\": \"\",\n \"hex\": \"\",\n \"enabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7e42ce3e-48b1-45b0-8cac-d408e4d9844f", "name": "Authenticated user is missing the `EDITAR_CAMPOSPERSONALIZADOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":definitionId", "options", ":optionId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "definitionId" }, { "disabled": false, "description": { "content": "(Required) Option ID", "type": "text/plain" }, "type": "any", "value": "", "key": "optionId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"value\": \"\",\n \"displayOrder\": \"\",\n \"hex\": \"\",\n \"enabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0c601001-1a96-4b87-a3c0-9578bd2fea01", "name": "Option not found for this definition", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":definitionId", "options", ":optionId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "definitionId" }, { "disabled": false, "description": { "content": "(Required) Option ID", "type": "text/plain" }, "type": "any", "value": "", "key": "optionId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"value\": \"\",\n \"displayOrder\": \"\",\n \"hex\": \"\",\n \"enabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "076acaa7-8b9d-4b1d-8dd6-d0393bd02a73", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":definitionId", "options", ":optionId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "definitionId" }, { "disabled": false, "description": { "content": "(Required) Option ID", "type": "text/plain" }, "type": "any", "value": "", "key": "optionId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"value\": \"\",\n \"displayOrder\": \"\",\n \"hex\": \"\",\n \"enabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b34fa766-e643-43f6-9c71-3782e2ceb1ec", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":definitionId", "options", ":optionId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "definitionId" }, { "disabled": false, "description": { "content": "(Required) Option ID", "type": "text/plain" }, "type": "any", "value": "", "key": "optionId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"value\": \"\",\n \"displayOrder\": \"\",\n \"hex\": \"\",\n \"enabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4b4190ef-547b-4449-93fd-b37b1412dd24", "name": "Delete option", "request": { "name": "Delete option", "description": { "content": "Deletes an option. Previously stored entity values with this label are left in place (readable but no longer writable); prefer disabling via `enabled=false` when the data should stay consistent. Send the `If-Match` header with the current ETag for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "custom-field-definitions", ":definitionId", "options", ":optionId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "definitionId", "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" } }, { "type": "any", "value": "", "key": "optionId", "disabled": false, "description": { "content": "(Required) Option ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "d9b1fce1-5946-4d2e-adcc-274a85c70722", "name": "Option deleted", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":definitionId", "options", ":optionId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "definitionId" }, { "disabled": false, "description": { "content": "(Required) Option ID", "type": "text/plain" }, "type": "any", "value": "", "key": "optionId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "47853881-bf31-4bb1-bd34-2015b07c6331", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":definitionId", "options", ":optionId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "definitionId" }, { "disabled": false, "description": { "content": "(Required) Option ID", "type": "text/plain" }, "type": "any", "value": "", "key": "optionId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7db02c4b-0354-4db8-807f-d38c0a0ed95e", "name": "Authenticated user is missing the `EDITAR_CAMPOSPERSONALIZADOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":definitionId", "options", ":optionId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "definitionId" }, { "disabled": false, "description": { "content": "(Required) Option ID", "type": "text/plain" }, "type": "any", "value": "", "key": "optionId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "96a09967-cebb-40cf-b5eb-b00393abd334", "name": "Option not found for this definition", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":definitionId", "options", ":optionId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "definitionId" }, { "disabled": false, "description": { "content": "(Required) Option ID", "type": "text/plain" }, "type": "any", "value": "", "key": "optionId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b0ca6b59-c203-447b-9cee-bf4e6d478bab", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":definitionId", "options", ":optionId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "definitionId" }, { "disabled": false, "description": { "content": "(Required) Option ID", "type": "text/plain" }, "type": "any", "value": "", "key": "optionId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "84ec6baa-e4e6-434c-a152-fe47dc6a64bb", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":definitionId", "options", ":optionId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "definitionId" }, { "disabled": false, "description": { "content": "(Required) Option ID", "type": "text/plain" }, "type": "any", "value": "", "key": "optionId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "a05740a6-b344-4ad0-b592-9e94c59a650c", "name": "List options of a custom field definition", "request": { "name": "List options of a custom field definition", "description": { "content": "Returns a paginated page of the definition's options with envelope `{data, totalCount, skip, limit, hasMore}`, ordered by displayOrder then value. `search` filters by case-insensitive containment on the value ÔÇö use it for autocomplete over large catalogs instead of fetching everything. Disabled options are hidden unless `includeDisabled=true`.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "custom-field-definitions", ":definitionId", "options" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" }, { "disabled": false, "description": { "content": "Case-insensitive containment filter on the option value.", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Include disabled options.", "type": "text/plain" }, "key": "includeDisabled", "value": "false" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [ { "type": "any", "value": "", "key": "definitionId", "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "9fdd31df-a031-421b-8c54-d4c0a4d8510e", "name": "Page of options", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":definitionId", "options" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" }, { "disabled": false, "description": { "content": "Case-insensitive containment filter on the option value.", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Include disabled options.", "type": "text/plain" }, "key": "includeDisabled", "value": "false" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "definitionId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "11aba59a-19c1-4c40-9343-4cd19e10e5f2", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":definitionId", "options" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" }, { "disabled": false, "description": { "content": "Case-insensitive containment filter on the option value.", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Include disabled options.", "type": "text/plain" }, "key": "includeDisabled", "value": "false" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "definitionId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8fc1cb8b-6940-4ef8-9f48-f6d589cf6bad", "name": "Authenticated user is missing the `VER_CAMPOSPERSONALIZADOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":definitionId", "options" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" }, { "disabled": false, "description": { "content": "Case-insensitive containment filter on the option value.", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Include disabled options.", "type": "text/plain" }, "key": "includeDisabled", "value": "false" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "definitionId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d41bf288-ed2a-4047-803a-9b5470e58e8b", "name": "Custom field definition not found", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":definitionId", "options" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" }, { "disabled": false, "description": { "content": "Case-insensitive containment filter on the option value.", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Include disabled options.", "type": "text/plain" }, "key": "includeDisabled", "value": "false" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "definitionId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9ad2efb3-a7b3-47b3-8116-8d27c01bf77b", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":definitionId", "options" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" }, { "disabled": false, "description": { "content": "Case-insensitive containment filter on the option value.", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Include disabled options.", "type": "text/plain" }, "key": "includeDisabled", "value": "false" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "definitionId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f57861b5-fd9d-4a40-90b4-ccd507d25e7e", "name": "Create option", "request": { "name": "Create option", "description": { "content": "Adds one option to a dataType=ENUM (or COLOR for EAV-backed featureTypes) definition. The `value` must be unique within the definition (it is what entity writes store). `hex` is only accepted for COLOR definitions. Business logic runs in the legacy WAR via the internal commands gateway.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "custom-field-definitions", ":definitionId", "options" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "definitionId", "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"value\": \"\",\n \"displayOrder\": \"\",\n \"hex\": \"\",\n \"enabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "e7634928-c409-405f-a249-6079187e5f29", "name": "Option created", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":definitionId", "options" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "definitionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"value\": \"\",\n \"displayOrder\": \"\",\n \"hex\": \"\",\n \"enabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"customFieldDefinitionId\": \"\",\n \"value\": \"\",\n \"displayOrder\": \"\",\n \"hex\": \"\",\n \"enabled\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "09c4e236-6220-4c0f-89d7-e8347e58ce2d", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":definitionId", "options" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "definitionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"value\": \"\",\n \"displayOrder\": \"\",\n \"hex\": \"\",\n \"enabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1b304f86-c67b-426a-ab65-57537284f1f0", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":definitionId", "options" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "definitionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"value\": \"\",\n \"displayOrder\": \"\",\n \"hex\": \"\",\n \"enabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "41253ccc-78d7-4d2b-b726-61274b894357", "name": "Authenticated user is missing the `EDITAR_CAMPOSPERSONALIZADOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":definitionId", "options" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "definitionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"value\": \"\",\n \"displayOrder\": \"\",\n \"hex\": \"\",\n \"enabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "eb158a44-619a-4652-ba90-b2340321d7dc", "name": "Custom field definition not found", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":definitionId", "options" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "definitionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"value\": \"\",\n \"displayOrder\": \"\",\n \"hex\": \"\",\n \"enabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "75801902-e6e6-42a3-98cb-f0c13d38598c", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":definitionId", "options" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "definitionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"value\": \"\",\n \"displayOrder\": \"\",\n \"hex\": \"\",\n \"enabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "bulk", "description": "", "item": [ { "id": "68019172-18d2-483c-8e0f-7f1bf3d8ae76", "name": "Bulk create options", "request": { "name": "Bulk create options", "description": { "content": "Adds up to 1000 options in one request (all-or-nothing: any invalid or duplicate entry rolls back the whole batch). Intended for imports of large catalogs; send multiple batches for bigger volumes.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "custom-field-definitions", ":definitionId", "options", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "definitionId", "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"value\": \"\",\n \"displayOrder\": \"\",\n \"hex\": \"\",\n \"enabled\": \"\"\n },\n {\n \"value\": \"\",\n \"displayOrder\": \"\",\n \"hex\": \"\",\n \"enabled\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "eca533eb-8db4-4365-8089-ad697a6b939c", "name": "Options created (array, in request order)", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":definitionId", "options", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "definitionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"value\": \"\",\n \"displayOrder\": \"\",\n \"hex\": \"\",\n \"enabled\": \"\"\n },\n {\n \"value\": \"\",\n \"displayOrder\": \"\",\n \"hex\": \"\",\n \"enabled\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"customFieldDefinitionId\": \"\",\n \"value\": \"\",\n \"displayOrder\": \"\",\n \"hex\": \"\",\n \"enabled\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d21d99d6-46de-42a5-8d06-dccdb70f21f4", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":definitionId", "options", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "definitionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"value\": \"\",\n \"displayOrder\": \"\",\n \"hex\": \"\",\n \"enabled\": \"\"\n },\n {\n \"value\": \"\",\n \"displayOrder\": \"\",\n \"hex\": \"\",\n \"enabled\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0909e3c6-f7ef-45f7-8923-7f17f426437b", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":definitionId", "options", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "definitionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"value\": \"\",\n \"displayOrder\": \"\",\n \"hex\": \"\",\n \"enabled\": \"\"\n },\n {\n \"value\": \"\",\n \"displayOrder\": \"\",\n \"hex\": \"\",\n \"enabled\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6aec3ca9-f6d9-4b45-a753-8fc403e52336", "name": "Authenticated user is missing the `EDITAR_CAMPOSPERSONALIZADOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":definitionId", "options", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "definitionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"value\": \"\",\n \"displayOrder\": \"\",\n \"hex\": \"\",\n \"enabled\": \"\"\n },\n {\n \"value\": \"\",\n \"displayOrder\": \"\",\n \"hex\": \"\",\n \"enabled\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4f9b5bd4-4e26-4356-a13e-3fadbff55aec", "name": "Custom field definition not found", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":definitionId", "options", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "definitionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"value\": \"\",\n \"displayOrder\": \"\",\n \"hex\": \"\",\n \"enabled\": \"\"\n },\n {\n \"value\": \"\",\n \"displayOrder\": \"\",\n \"hex\": \"\",\n \"enabled\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e9b6d80d-2847-401e-9082-8973ed2edab2", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions", ":definitionId", "options", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Feature namespace of the definition id. REQUIRED for EAV-backed featureTypes (`product-models`, `product-variants`, `manufacturing-custom-fields`), whose ids live in ges_customfield. Omit it (or pass a JSON-backed featureType) to resolve the id against cf_definition.", "type": "text/plain" }, "key": "featureType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Custom field definition ID", "type": "text/plain" }, "type": "any", "value": "", "key": "definitionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"value\": \"\",\n \"displayOrder\": \"\",\n \"hex\": \"\",\n \"enabled\": \"\"\n },\n {\n \"value\": \"\",\n \"displayOrder\": \"\",\n \"hex\": \"\",\n \"enabled\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "id": "5990f78d-3cd1-45f4-b560-8ab5c1723498", "name": "List custom field definitions", "request": { "name": "List custom field definitions", "description": { "content": "Returns a paginated list of custom field definitions with envelope `{data, totalCount, skip, limit, hasMore}`. Optional `featureType` filter: JSON-backed (customers, optometry-exams, audiology-exams, contactology-fittings, contact-lens-exams) or EAV-backed bridge (product-models, product-variants, manufacturing-custom-fields; scoped to the caller's companies). Disabled definitions are hidden unless `includeDisabled=true`. Fixed ordering: featureType, displayOrder, apiName.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "custom-field-definitions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by owning feature (public v2 nomenclature).", "type": "text/plain" }, "key": "featureType", "value": "" }, { "disabled": false, "description": { "content": "Include disabled definitions.", "type": "text/plain" }, "key": "includeDisabled", "value": "false" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "4f916c2e-8944-4d61-96a8-d327056d79dc", "name": "Page of custom field definitions", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by owning feature (public v2 nomenclature).", "type": "text/plain" }, "key": "featureType", "value": "" }, { "disabled": false, "description": { "content": "Include disabled definitions.", "type": "text/plain" }, "key": "includeDisabled", "value": "false" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2b8b5c75-69fb-45d1-ac5d-d4ddd7d661ea", "name": "Unknown featureType", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by owning feature (public v2 nomenclature).", "type": "text/plain" }, "key": "featureType", "value": "" }, { "disabled": false, "description": { "content": "Include disabled definitions.", "type": "text/plain" }, "key": "includeDisabled", "value": "false" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bc879a89-d78f-4a0c-99fe-1f6c5abc14c7", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by owning feature (public v2 nomenclature).", "type": "text/plain" }, "key": "featureType", "value": "" }, { "disabled": false, "description": { "content": "Include disabled definitions.", "type": "text/plain" }, "key": "includeDisabled", "value": "false" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "36d914ff-b9aa-4cba-a6ed-6a20fd18edff", "name": "Authenticated user is missing the `VER_CAMPOSPERSONALIZADOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by owning feature (public v2 nomenclature).", "type": "text/plain" }, "key": "featureType", "value": "" }, { "disabled": false, "description": { "content": "Include disabled definitions.", "type": "text/plain" }, "key": "includeDisabled", "value": "false" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b64f180a-a68d-464f-b7f0-81803807ea85", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by owning feature (public v2 nomenclature).", "type": "text/plain" }, "key": "featureType", "value": "" }, { "disabled": false, "description": { "content": "Include disabled definitions.", "type": "text/plain" }, "key": "includeDisabled", "value": "false" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f8f68ca8-7639-49cd-b8ea-c1be12ff020d", "name": "Create custom field definition", "request": { "name": "Create custom field definition", "description": { "content": "Creates a new custom field definition for the given `featureType`. The `apiName` must be unique within the featureType. For `dataType=ENUM` the `options` array is accepted as an optional creation seed (each label becomes an option row); afterwards options are managed through the paginated `/options` sub-resource. EAV-backed featureTypes (product-models, product-variants, manufacturing-custom-fields) accept dataType COLOR, an optional `companyId` (defaults to the caller's current company) and store into ges_customfield until the ADR-003 Fase 3 migration. Business logic runs in the legacy WAR via the internal commands gateway.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "custom-field-definitions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"featureType\": \"\",\n \"apiName\": \"\",\n \"dataType\": \"\",\n \"label\": \"\",\n \"required\": \"\",\n \"indexable\": \"\",\n \"options\": [\n \"\",\n \"\"\n ],\n \"displayOrder\": \"\",\n \"displayGroup\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "852c9db5-678f-4512-af51-9b973f17ccd7", "name": "Custom field definition created", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"featureType\": \"\",\n \"apiName\": \"\",\n \"dataType\": \"\",\n \"label\": \"\",\n \"required\": \"\",\n \"indexable\": \"\",\n \"options\": [\n \"\",\n \"\"\n ],\n \"displayOrder\": \"\",\n \"displayGroup\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"featureType\": \"\",\n \"apiName\": \"\",\n \"dataType\": \"\",\n \"label\": \"\",\n \"required\": \"\",\n \"indexable\": \"\",\n \"optionCount\": \"\",\n \"displayOrder\": \"\",\n \"displayGroup\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bcc68319-7b2d-415c-893d-1c32592337d3", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"featureType\": \"\",\n \"apiName\": \"\",\n \"dataType\": \"\",\n \"label\": \"\",\n \"required\": \"\",\n \"indexable\": \"\",\n \"options\": [\n \"\",\n \"\"\n ],\n \"displayOrder\": \"\",\n \"displayGroup\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "273fa39b-2f83-4512-a50d-72cecc4bf955", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"featureType\": \"\",\n \"apiName\": \"\",\n \"dataType\": \"\",\n \"label\": \"\",\n \"required\": \"\",\n \"indexable\": \"\",\n \"options\": [\n \"\",\n \"\"\n ],\n \"displayOrder\": \"\",\n \"displayGroup\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "636428e0-7ee9-4a3a-ba71-5eef76af2615", "name": "Authenticated user is missing the `CREAR_CAMPOSPERSONALIZADOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"featureType\": \"\",\n \"apiName\": \"\",\n \"dataType\": \"\",\n \"label\": \"\",\n \"required\": \"\",\n \"indexable\": \"\",\n \"options\": [\n \"\",\n \"\"\n ],\n \"displayOrder\": \"\",\n \"displayGroup\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9a7a1496-f127-4701-9072-2b13a62bb573", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "custom-field-definitions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"featureType\": \"\",\n \"apiName\": \"\",\n \"dataType\": \"\",\n \"label\": \"\",\n \"required\": \"\",\n \"indexable\": \"\",\n \"options\": [\n \"\",\n \"\"\n ],\n \"displayOrder\": \"\",\n \"displayGroup\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "coupon-types", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "49875901-ac5b-4bcc-8288-0b5fd362a882", "name": "Get coupon type by ID", "request": { "name": "Get coupon type by ID", "description": { "content": "Returns a single coupon type by its primary key.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "coupon-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Coupon type ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "e616c61e-d181-4684-bc7f-419f411693b3", "name": "Coupon type found", "originalRequest": { "url": { "path": [ "api", "v2", "coupon-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Coupon type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"expirationDays\": \"\",\n \"expiresEndOfMonth\": \"\",\n \"userKind\": \"C\",\n \"nominative\": \"\",\n \"multipleUse\": \"\",\n \"requiresExternalReference\": \"\",\n \"discountKind\": \"M\",\n \"discount\": \"\",\n \"allCategories\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ad3b3b56-845d-4f98-9dfe-d342e45feef8", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "coupon-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Coupon type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "30b500ad-b335-42f5-9e91-36fdd469ab6e", "name": "Authenticated user is missing the `VER_TIPOPIN` permission", "originalRequest": { "url": { "path": [ "api", "v2", "coupon-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Coupon type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e59b33c6-a7c3-40a7-9ba4-8c0a51cd99a7", "name": "Coupon type not found", "originalRequest": { "url": { "path": [ "api", "v2", "coupon-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Coupon type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "12b13f81-990d-4483-97fa-faa26b12a565", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "coupon-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Coupon type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0ec4ce52-5a58-4d27-8920-995f586eb395", "name": "Update coupon type", "request": { "name": "Update coupon type", "description": { "content": "Full replacement of an existing coupon type.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "coupon-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Coupon type ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"expirationDays\": \"\",\n \"expiresEndOfMonth\": \"\",\n \"userKind\": \"E\",\n \"nominative\": \"\",\n \"multipleUse\": \"\",\n \"requiresExternalReference\": \"\",\n \"discountKind\": \"M\",\n \"discount\": \"\",\n \"allCategories\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "c0453c1b-c4c1-4b1d-8bce-4a6d1194aa06", "name": "Coupon type updated", "originalRequest": { "url": { "path": [ "api", "v2", "coupon-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Coupon type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"expirationDays\": \"\",\n \"expiresEndOfMonth\": \"\",\n \"userKind\": \"E\",\n \"nominative\": \"\",\n \"multipleUse\": \"\",\n \"requiresExternalReference\": \"\",\n \"discountKind\": \"M\",\n \"discount\": \"\",\n \"allCategories\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"expirationDays\": \"\",\n \"expiresEndOfMonth\": \"\",\n \"userKind\": \"C\",\n \"nominative\": \"\",\n \"multipleUse\": \"\",\n \"requiresExternalReference\": \"\",\n \"discountKind\": \"M\",\n \"discount\": \"\",\n \"allCategories\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c3a09dbc-9757-4ae9-adfc-10b5dcee76d5", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "coupon-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Coupon type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"expirationDays\": \"\",\n \"expiresEndOfMonth\": \"\",\n \"userKind\": \"E\",\n \"nominative\": \"\",\n \"multipleUse\": \"\",\n \"requiresExternalReference\": \"\",\n \"discountKind\": \"M\",\n \"discount\": \"\",\n \"allCategories\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9940df03-8cbe-4711-b419-d0b4c6567052", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "coupon-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Coupon type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"expirationDays\": \"\",\n \"expiresEndOfMonth\": \"\",\n \"userKind\": \"E\",\n \"nominative\": \"\",\n \"multipleUse\": \"\",\n \"requiresExternalReference\": \"\",\n \"discountKind\": \"M\",\n \"discount\": \"\",\n \"allCategories\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "13dde5c4-db45-43cc-8a60-aa9702414f77", "name": "Authenticated user is missing the `EDITAR_TIPOPIN` permission", "originalRequest": { "url": { "path": [ "api", "v2", "coupon-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Coupon type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"expirationDays\": \"\",\n \"expiresEndOfMonth\": \"\",\n \"userKind\": \"E\",\n \"nominative\": \"\",\n \"multipleUse\": \"\",\n \"requiresExternalReference\": \"\",\n \"discountKind\": \"M\",\n \"discount\": \"\",\n \"allCategories\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "db0b62ee-961c-4aca-a2ea-9a339b3c125c", "name": "Coupon type not found", "originalRequest": { "url": { "path": [ "api", "v2", "coupon-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Coupon type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"expirationDays\": \"\",\n \"expiresEndOfMonth\": \"\",\n \"userKind\": \"E\",\n \"nominative\": \"\",\n \"multipleUse\": \"\",\n \"requiresExternalReference\": \"\",\n \"discountKind\": \"M\",\n \"discount\": \"\",\n \"allCategories\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "93c18674-b3a8-4fab-9291-7ee711faa382", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "coupon-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Coupon type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"expirationDays\": \"\",\n \"expiresEndOfMonth\": \"\",\n \"userKind\": \"E\",\n \"nominative\": \"\",\n \"multipleUse\": \"\",\n \"requiresExternalReference\": \"\",\n \"discountKind\": \"M\",\n \"discount\": \"\",\n \"allCategories\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8e481dae-af0e-4750-8b33-d0bd89a73afb", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "coupon-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Coupon type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"expirationDays\": \"\",\n \"expiresEndOfMonth\": \"\",\n \"userKind\": \"E\",\n \"nominative\": \"\",\n \"multipleUse\": \"\",\n \"requiresExternalReference\": \"\",\n \"discountKind\": \"M\",\n \"discount\": \"\",\n \"allCategories\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7183ad7e-778f-4a77-8fe8-2968c0ed27c8", "name": "Delete coupon type", "request": { "name": "Delete coupon type", "description": { "content": "Deletes a coupon type.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "coupon-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Coupon type ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "acc37ce0-4041-4588-bfd8-d347f169409d", "name": "Coupon type deleted", "originalRequest": { "url": { "path": [ "api", "v2", "coupon-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Coupon type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c8c78b41-f8c8-4d2c-823f-4cac81bd3d35", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "coupon-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Coupon type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d1283f56-83d1-48c3-9a59-b51a34fbc2e4", "name": "Authenticated user is missing the `BORRAR_TIPOPIN` permission", "originalRequest": { "url": { "path": [ "api", "v2", "coupon-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Coupon type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "832b7b5c-453a-4cb0-804d-15e92eb9bd13", "name": "Coupon type not found", "originalRequest": { "url": { "path": [ "api", "v2", "coupon-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Coupon type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "73ff5a88-679f-4282-b579-8e13073da1d3", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "coupon-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Coupon type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0cec92c5-cf2e-4574-a80f-6fbb8f9dba32", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "coupon-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Coupon type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3529cb36-c6aa-4f3b-bcf3-bf78ea380bbe", "name": "Merge-patch coupon type", "request": { "name": "Merge-patch coupon type", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "coupon-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Coupon type ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "11b78d83-1ab8-4e7b-96e0-b040c653f23b", "name": "Coupon type patched", "originalRequest": { "url": { "path": [ "api", "v2", "coupon-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Coupon type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"expirationDays\": \"\",\n \"expiresEndOfMonth\": \"\",\n \"userKind\": \"C\",\n \"nominative\": \"\",\n \"multipleUse\": \"\",\n \"requiresExternalReference\": \"\",\n \"discountKind\": \"M\",\n \"discount\": \"\",\n \"allCategories\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8a0d098e-f843-4beb-b73c-f3b3e5f7c2f1", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "coupon-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Coupon type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1fb316fb-1fa4-488b-a439-e9bf76f999bb", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "coupon-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Coupon type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "97405ba7-7e01-4feb-a321-e96290748762", "name": "Authenticated user is missing the `EDITAR_TIPOPIN` permission", "originalRequest": { "url": { "path": [ "api", "v2", "coupon-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Coupon type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0cbba59d-9c8e-4f2b-a8f5-440461b347a6", "name": "Coupon type not found", "originalRequest": { "url": { "path": [ "api", "v2", "coupon-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Coupon type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "df6edec5-ac45-4ce9-bf81-431f8c123fd2", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "coupon-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Coupon type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "edf72b4b-e10d-445f-a6c6-9ef80709eb19", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "coupon-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Coupon type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "ea1cb500-a6cd-42ba-8d2e-90eb76b097a7", "name": "List coupon types", "request": { "name": "List coupon types", "description": { "content": "Returns a paginated list of coupon types with envelope `{data, totalCount, skip, limit, hasMore}`. Supports optional RSQL `filter`, `sort` (default `lastModifiedAt:desc`), `skip`/`limit` pagination and `modifiedAfter`/`modifiedBefore` bookends.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "coupon-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "57d18e34-ff61-46e0-a045-3a759b7768d6", "name": "Page of coupon types", "originalRequest": { "url": { "path": [ "api", "v2", "coupon-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "39f2b7bf-6aff-4594-b76b-bafa263ed4a6", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "coupon-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ca0cb10d-64a0-43a5-ac5e-2d5162149cc6", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "coupon-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "03662efa-bc9c-4df0-9046-ac7baeb6a898", "name": "Authenticated user is missing the `VER_TIPOPIN` permission", "originalRequest": { "url": { "path": [ "api", "v2", "coupon-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c9e8fe0a-8c6a-436f-81b3-02a9a3379371", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "coupon-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7daf8ecc-c313-4cfd-80bf-db74ad32f4ae", "name": "Create coupon type", "request": { "name": "Create coupon type", "description": { "content": "Creates a new coupon type. Business logic runs in the legacy WAR. `code` and `name` are required.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "coupon-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"expirationDays\": \"\",\n \"expiresEndOfMonth\": \"\",\n \"userKind\": \"E\",\n \"nominative\": \"\",\n \"multipleUse\": \"\",\n \"requiresExternalReference\": \"\",\n \"discountKind\": \"M\",\n \"discount\": \"\",\n \"allCategories\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "9a50b6e3-3e92-4f92-8f2c-e2cb36b937de", "name": "Coupon type created", "originalRequest": { "url": { "path": [ "api", "v2", "coupon-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"expirationDays\": \"\",\n \"expiresEndOfMonth\": \"\",\n \"userKind\": \"E\",\n \"nominative\": \"\",\n \"multipleUse\": \"\",\n \"requiresExternalReference\": \"\",\n \"discountKind\": \"M\",\n \"discount\": \"\",\n \"allCategories\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"expirationDays\": \"\",\n \"expiresEndOfMonth\": \"\",\n \"userKind\": \"C\",\n \"nominative\": \"\",\n \"multipleUse\": \"\",\n \"requiresExternalReference\": \"\",\n \"discountKind\": \"M\",\n \"discount\": \"\",\n \"allCategories\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "318ce37d-9d34-4bf5-a4b8-cb07bc8099c3", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "coupon-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"expirationDays\": \"\",\n \"expiresEndOfMonth\": \"\",\n \"userKind\": \"E\",\n \"nominative\": \"\",\n \"multipleUse\": \"\",\n \"requiresExternalReference\": \"\",\n \"discountKind\": \"M\",\n \"discount\": \"\",\n \"allCategories\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1f075432-0258-47c6-bf18-1d2524d85e7d", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "coupon-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"expirationDays\": \"\",\n \"expiresEndOfMonth\": \"\",\n \"userKind\": \"E\",\n \"nominative\": \"\",\n \"multipleUse\": \"\",\n \"requiresExternalReference\": \"\",\n \"discountKind\": \"M\",\n \"discount\": \"\",\n \"allCategories\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "58e7929b-3bcf-4df7-b9fa-00e4ed2087fc", "name": "Authenticated user is missing the `CREAR_TIPOPIN` permission", "originalRequest": { "url": { "path": [ "api", "v2", "coupon-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"expirationDays\": \"\",\n \"expiresEndOfMonth\": \"\",\n \"userKind\": \"E\",\n \"nominative\": \"\",\n \"multipleUse\": \"\",\n \"requiresExternalReference\": \"\",\n \"discountKind\": \"M\",\n \"discount\": \"\",\n \"allCategories\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "27575725-82e4-48ca-a685-84dda6e80c22", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "coupon-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"expirationDays\": \"\",\n \"expiresEndOfMonth\": \"\",\n \"userKind\": \"E\",\n \"nominative\": \"\",\n \"multipleUse\": \"\",\n \"requiresExternalReference\": \"\",\n \"discountKind\": \"M\",\n \"discount\": \"\",\n \"allCategories\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3b485e73-6ee3-4c8d-920c-e92268a268c9", "name": "Bulk delete coupon types", "request": { "name": "Bulk delete coupon types", "description": { "content": "Removes every id in `ids` as a single all-or-nothing transaction.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "coupon-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "1ebf5ffc-5f70-4b26-a877-a1e906f7e3e3", "name": "All entities deleted", "originalRequest": { "url": { "path": [ "api", "v2", "coupon-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"deleted\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bdc3d9a4-6b8b-4ea1-adde-13d357e77a02", "name": "Empty `ids` or unknown id", "originalRequest": { "url": { "path": [ "api", "v2", "coupon-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "38e4392f-5cfd-44d4-b3a9-258cd1e08ee9", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "coupon-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6786cbff-9aff-4206-a288-26c62850ecbd", "name": "Authenticated user is missing the `BORRAR_TIPOPIN` permission", "originalRequest": { "url": { "path": [ "api", "v2", "coupon-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b48aabc7-7825-43d8-b046-c3d2f3f534af", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "coupon-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7a1c84b0-0213-4b4d-a3bc-58b198d80f15", "name": "Bulk patch coupon types", "request": { "name": "Bulk patch coupon types", "description": { "content": "Applies the same `patch` to every id in `ids` as a single all-or-nothing transaction. Editable fields: `description`, `categoryIds`.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "coupon-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"patch\": {\n \"key_0\": \"string\",\n \"key_1\": 4074,\n \"key_2\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "433b2eb9-4984-4778-89f8-a10acfaa931f", "name": "All entities updated", "originalRequest": { "url": { "path": [ "api", "v2", "coupon-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"patch\": {\n \"key_0\": \"string\",\n \"key_1\": 4074,\n \"key_2\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"updated\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b7d397e5-b15b-405d-9349-b88aa10f3c37", "name": "Empty `ids`/`patch`, malformed payload or non-whitelisted field", "originalRequest": { "url": { "path": [ "api", "v2", "coupon-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"patch\": {\n \"key_0\": \"string\",\n \"key_1\": 4074,\n \"key_2\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "519fd970-2156-4e2f-a84f-1b8911f9fd25", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "coupon-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"patch\": {\n \"key_0\": \"string\",\n \"key_1\": 4074,\n \"key_2\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "64880bb3-1dd2-4471-b4c6-b341d263bcd8", "name": "Authenticated user is missing the `EDITAR_TIPOPIN` permission", "originalRequest": { "url": { "path": [ "api", "v2", "coupon-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"patch\": {\n \"key_0\": \"string\",\n \"key_1\": 4074,\n \"key_2\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "42af1f48-bd8d-44b6-900d-f396882b1569", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "coupon-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"patch\": {\n \"key_0\": \"string\",\n \"key_1\": 4074,\n \"key_2\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "new", "description": "", "item": [ { "id": "42af8ec8-a6ae-4eff-a551-6347bec6dbd0", "name": "Prototype coupon type for a creation form", "request": { "name": "Prototype coupon type for a creation form", "description": { "content": "Returns a non-persisted coupon type pre-populated with backend defaults (current company, `enabled=true`, `allCategories=true`, `discountKind=P`). Optional JSON hints: `companyId`, `copyFromId`. Call `POST /api/v2/coupon-types` to persist.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "coupon-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "e1680137-e34b-4dc8-9fea-38c702a97a9e", "name": "Coupon type prototype with defaults", "originalRequest": { "url": { "path": [ "api", "v2", "coupon-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"expirationDays\": \"\",\n \"expiresEndOfMonth\": \"\",\n \"userKind\": \"C\",\n \"nominative\": \"\",\n \"multipleUse\": \"\",\n \"requiresExternalReference\": \"\",\n \"discountKind\": \"M\",\n \"discount\": \"\",\n \"allCategories\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ],\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e377a349-025e-49d3-b75b-3e4442468b87", "name": "Invalid prepare-create hints", "originalRequest": { "url": { "path": [ "api", "v2", "coupon-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0290721d-1841-4b36-9a50-1d78778d9937", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "coupon-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "392e48b8-0ae4-4f0a-9684-f9244ec1c912", "name": "Authenticated user is missing the `CREAR_TIPOPIN` permission", "originalRequest": { "url": { "path": [ "api", "v2", "coupon-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fce73334-1a47-4673-a589-c3b1797e52a0", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "coupon-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "companies", "description": "", "item": [ { "name": "{companyId}", "description": "", "item": [ { "name": "verifactu-configuration", "description": "", "item": [ { "id": "43686f88-fe09-4a5b-8551-2d3809916ab0", "name": "Get the company Verifactu configuration", "request": { "name": "Get the company Verifactu configuration", "description": { "content": "Returns the singleton configuration and its ETag. A company without a completed configuration returns 404.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "companies", ":companyId", "verifactu-configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "companyId", "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "2528a005-1748-48d6-a4f7-da3982074bbf", "name": "Configuration found", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "verifactu-configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"antiFraudEnabled\": \"\",\n \"companyId\": \"\",\n \"sendFullInvoicesAutomatically\": \"\",\n \"sendSimplifiedInvoicesAutomatically\": \"\",\n \"submissionMode\": \"NON_VERIFACTU\",\n \"certificateId\": \"\",\n \"certificateName\": \"\",\n \"certificateFingerprint\": \"\",\n \"certificateExpiresAt\": \"\",\n \"certificateUploadedAt\": \"\",\n \"version\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a0dd707f-0dc3-42a6-af4d-4d063b4bd7cd", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "verifactu-configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d7a30d25-9491-4b98-b82d-736ec1aae8e2", "name": "Missing VER_CONFIGURACIONVERIFACTU permission", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "verifactu-configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1de21a3d-76b6-481f-8d5b-e9329d8f558f", "name": "Company is outside scope or configuration does not exist", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "verifactu-configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "71563b00-b03f-487d-8e78-9a62a1660a9a", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "verifactu-configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "19b034e0-469a-403b-9504-3a9643929be5", "name": "Upsert the company Verifactu configuration", "request": { "name": "Upsert the company Verifactu configuration", "description": { "content": "Atomically creates or replaces the singleton metadata. certificateId must reference a certificate uploaded for this company.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "companies", ":companyId", "verifactu-configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "companyId", "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"antiFraudEnabled\": \"\",\n \"companyId\": \"\",\n \"sendFullInvoicesAutomatically\": \"\",\n \"sendSimplifiedInvoicesAutomatically\": \"\",\n \"submissionMode\": \"NON_VERIFACTU\",\n \"certificateId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "df03f03c-aad4-45b2-8f0d-cad1302dde57", "name": "Configuration created or updated", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "verifactu-configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"antiFraudEnabled\": \"\",\n \"companyId\": \"\",\n \"sendFullInvoicesAutomatically\": \"\",\n \"sendSimplifiedInvoicesAutomatically\": \"\",\n \"submissionMode\": \"NON_VERIFACTU\",\n \"certificateId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"antiFraudEnabled\": \"\",\n \"companyId\": \"\",\n \"sendFullInvoicesAutomatically\": \"\",\n \"sendSimplifiedInvoicesAutomatically\": \"\",\n \"submissionMode\": \"NON_VERIFACTU\",\n \"certificateId\": \"\",\n \"certificateName\": \"\",\n \"certificateFingerprint\": \"\",\n \"certificateExpiresAt\": \"\",\n \"certificateUploadedAt\": \"\",\n \"version\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "91a37e70-895f-49ab-9807-48fcc520c577", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "verifactu-configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"antiFraudEnabled\": \"\",\n \"companyId\": \"\",\n \"sendFullInvoicesAutomatically\": \"\",\n \"sendSimplifiedInvoicesAutomatically\": \"\",\n \"submissionMode\": \"NON_VERIFACTU\",\n \"certificateId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "14140ae4-3aff-418b-8379-5ded2bd6c430", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "verifactu-configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"antiFraudEnabled\": \"\",\n \"companyId\": \"\",\n \"sendFullInvoicesAutomatically\": \"\",\n \"sendSimplifiedInvoicesAutomatically\": \"\",\n \"submissionMode\": \"NON_VERIFACTU\",\n \"certificateId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c4e676c2-9563-4397-82ea-56f762388065", "name": "Missing EDITAR_CONFIGURACIONVERIFACTU permission", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "verifactu-configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"antiFraudEnabled\": \"\",\n \"companyId\": \"\",\n \"sendFullInvoicesAutomatically\": \"\",\n \"sendSimplifiedInvoicesAutomatically\": \"\",\n \"submissionMode\": \"NON_VERIFACTU\",\n \"certificateId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e10bd8c4-c079-4c45-858c-cceb5b84a957", "name": "Company is outside the authenticated scope", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "verifactu-configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"antiFraudEnabled\": \"\",\n \"companyId\": \"\",\n \"sendFullInvoicesAutomatically\": \"\",\n \"sendSimplifiedInvoicesAutomatically\": \"\",\n \"submissionMode\": \"NON_VERIFACTU\",\n \"certificateId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "85757321-7b83-4fa4-8916-0dce88360d17", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "verifactu-configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"antiFraudEnabled\": \"\",\n \"companyId\": \"\",\n \"sendFullInvoicesAutomatically\": \"\",\n \"sendSimplifiedInvoicesAutomatically\": \"\",\n \"submissionMode\": \"NON_VERIFACTU\",\n \"certificateId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "102adf2c-9aef-47c7-9147-9daece156778", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "verifactu-configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"antiFraudEnabled\": \"\",\n \"companyId\": \"\",\n \"sendFullInvoicesAutomatically\": \"\",\n \"sendSimplifiedInvoicesAutomatically\": \"\",\n \"submissionMode\": \"NON_VERIFACTU\",\n \"certificateId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "new", "description": "", "item": [ { "id": "b2bfea11-6ef7-477a-8011-e60dfce3ad56", "name": "Prototype an Verifactu configuration", "request": { "name": "Prototype an Verifactu configuration", "description": { "content": "Returns form defaults and does not persist a configuration.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "companies", ":companyId", "verifactu-configuration", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "companyId", "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "651fe30a-67cf-4d6b-b306-754c89a64531", "name": "Non-persistent prototype", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "verifactu-configuration", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"antiFraudEnabled\": \"\",\n \"companyId\": \"\",\n \"sendFullInvoicesAutomatically\": \"\",\n \"sendSimplifiedInvoicesAutomatically\": \"\",\n \"submissionMode\": \"NON_VERIFACTU\",\n \"certificateId\": \"\",\n \"certificateName\": \"\",\n \"certificateFingerprint\": \"\",\n \"certificateExpiresAt\": \"\",\n \"certificateUploadedAt\": \"\",\n \"version\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "89ce5749-84a8-42fe-96bd-bb2530dc5d37", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "verifactu-configuration", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "687bbaa2-8965-46a6-9262-814c77563cc7", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "verifactu-configuration", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6dc78e73-a77b-4556-b780-f9944a8aff2c", "name": "Missing EDITAR_CONFIGURACIONVERIFACTU permission", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "verifactu-configuration", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e81aefb2-ec8b-4377-a223-1186b4e39b9a", "name": "Company is outside the authenticated scope", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "verifactu-configuration", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e74bc748-c5a3-465d-9352-2beb46da8ac6", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "verifactu-configuration", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "certificate", "description": "", "item": [ { "id": "1599eb74-9184-4754-8f3f-d46c3453ce9e", "name": "Upload and validate the company PKCS#12 certificate", "request": { "name": "Upload and validate the company PKCS#12 certificate", "description": { "content": "Stages a .p12/.pfx certificate and returns an opaque certificateId. The active configuration changes only after a successful PUT.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "companies", ":companyId", "verifactu-configuration", "certificate" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) PKCS#12 password", "type": "text/plain" }, "key": "password", "value": "" }, { "disabled": false, "description": { "content": "Replace an already staged certificate", "type": "text/plain" }, "key": "replace", "value": "true" } ], "variable": [ { "type": "any", "value": "", "key": "companyId", "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) PKCS#12 certificate (.p12 or .pfx)", "type": "text/plain" }, "key": "file", "type": "file" } ] }, "auth": null }, "response": [ { "id": "aef14b7c-1901-41de-af62-45ce72a53538", "name": "Certificate validated and staged", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "verifactu-configuration", "certificate" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) PKCS#12 password", "type": "text/plain" }, "key": "password", "value": "" }, { "disabled": false, "description": { "content": "Replace an already staged certificate", "type": "text/plain" }, "key": "replace", "value": "true" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) PKCS#12 certificate (.p12 or .pfx)", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"certificateId\": \"\",\n \"certificateName\": \"\",\n \"certificateFingerprint\": \"\",\n \"certificateExpiresAt\": \"\",\n \"certificateUploadedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ea08ceaf-4f18-4e7e-a5bd-5b5c52369144", "name": "Missing file, invalid PKCS#12 or wrong password", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "verifactu-configuration", "certificate" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) PKCS#12 password", "type": "text/plain" }, "key": "password", "value": "" }, { "disabled": false, "description": { "content": "Replace an already staged certificate", "type": "text/plain" }, "key": "replace", "value": "true" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) PKCS#12 certificate (.p12 or .pfx)", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "da73249f-7523-4182-a80f-d5fa433beb35", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "verifactu-configuration", "certificate" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) PKCS#12 password", "type": "text/plain" }, "key": "password", "value": "" }, { "disabled": false, "description": { "content": "Replace an already staged certificate", "type": "text/plain" }, "key": "replace", "value": "true" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) PKCS#12 certificate (.p12 or .pfx)", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "de8973b3-4b60-4df0-a24c-7b5286b3c8ee", "name": "Missing EDITAR_CONFIGURACIONVERIFACTU permission", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "verifactu-configuration", "certificate" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) PKCS#12 password", "type": "text/plain" }, "key": "password", "value": "" }, { "disabled": false, "description": { "content": "Replace an already staged certificate", "type": "text/plain" }, "key": "replace", "value": "true" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) PKCS#12 certificate (.p12 or .pfx)", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cc7e0b6a-5a98-40ba-a3a1-225987a071fb", "name": "Company is outside the authenticated scope", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "verifactu-configuration", "certificate" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) PKCS#12 password", "type": "text/plain" }, "key": "password", "value": "" }, { "disabled": false, "description": { "content": "Replace an already staged certificate", "type": "text/plain" }, "key": "replace", "value": "true" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) PKCS#12 certificate (.p12 or .pfx)", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5a89c74e-25f5-4be4-86c3-4f96f2c022c9", "name": "Certificate exceeds 5 MB", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "verifactu-configuration", "certificate" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) PKCS#12 password", "type": "text/plain" }, "key": "password", "value": "" }, { "disabled": false, "description": { "content": "Replace an already staged certificate", "type": "text/plain" }, "key": "replace", "value": "true" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) PKCS#12 certificate (.p12 or .pfx)", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4f66f5eb-6646-48c6-af7a-bb83fda6fd23", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "verifactu-configuration", "certificate" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) PKCS#12 password", "type": "text/plain" }, "key": "password", "value": "" }, { "disabled": false, "description": { "content": "Replace an already staged certificate", "type": "text/plain" }, "key": "replace", "value": "true" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) PKCS#12 certificate (.p12 or .pfx)", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "sat-mexico-configuration", "description": "", "item": [ { "id": "682e7d2d-42b8-46fd-bc01-a0d92cc4b7b5", "name": "Get the company Mexico SAT configuration", "request": { "name": "Get the company Mexico SAT configuration", "description": { "content": "Returns the singleton configuration and its ETag. A company without a completed configuration returns 404.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "companies", ":companyId", "sat-mexico-configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "companyId", "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "4dc58358-2715-4b62-9366-f32baa7b2b86", "name": "Configuration found", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "sat-mexico-configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"active\": \"\",\n \"companyId\": \"\",\n \"pacType\": \"CONTPAQ\",\n \"testMode\": \"\",\n \"pacUser\": \"\",\n \"syncInvoices\": \"\",\n \"syncIncomingPayments\": \"\",\n \"syncCreditNotes\": \"\",\n \"syncPaymentCancel\": \"\",\n \"hoursBlockedAfterRejectedCancellation\": \"\",\n \"hoursBeforeReinvoicing\": \"\",\n \"globalBillingPerCompany\": \"\",\n \"globalPerTicket\": \"\",\n \"globalDetailedPerLine\": \"\",\n \"globalBillingPeriodicity\": \"05\",\n \"globalProductId\": \"\",\n \"globalBranchId\": \"\",\n \"globalCustomerId\": \"\",\n \"defaultPaymentMethodId\": \"\",\n \"certificateId\": \"\",\n \"certificateName\": \"\",\n \"certificateKeyName\": \"\",\n \"certificateHolderName\": \"\",\n \"certificateIssuerName\": \"\",\n \"certificateSerialNumber\": \"\",\n \"certificateValidFrom\": \"\",\n \"certificateValidTo\": \"\",\n \"certificateUploadedAt\": \"\",\n \"version\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a752a4db-1e9e-4420-95d3-5146260ed755", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "sat-mexico-configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5cf31346-28c8-4b81-90c3-702f1f683191", "name": "Missing VER_CONFIGURACIONSATMEXICO permission", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "sat-mexico-configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "32df4f76-2194-49b7-b4b7-8e53b5528f16", "name": "Company is outside scope or configuration does not exist", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "sat-mexico-configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4920d74b-6492-4fbb-b0ca-40f6b1b7d70d", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "sat-mexico-configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f90e0f3b-f418-4543-a2a3-3e5dfa8d210b", "name": "Upsert the company Mexico SAT configuration", "request": { "name": "Upsert the company Mexico SAT configuration", "description": { "content": "Atomically creates or replaces the singleton metadata. certificateId must reference a staged CSD (.cer + .key) uploaded for this company.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "companies", ":companyId", "sat-mexico-configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "companyId", "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"active\": \"\",\n \"companyId\": \"\",\n \"pacType\": \"FINKOK\",\n \"testMode\": \"\",\n \"pacUser\": \"\",\n \"pacPassword\": \"\",\n \"licenceId\": \"\",\n \"syncInvoices\": \"\",\n \"syncIncomingPayments\": \"\",\n \"syncCreditNotes\": \"\",\n \"syncPaymentCancel\": \"\",\n \"hoursBlockedAfterRejectedCancellation\": \"\",\n \"hoursBeforeReinvoicing\": \"\",\n \"globalBillingPerCompany\": \"\",\n \"globalPerTicket\": \"\",\n \"globalDetailedPerLine\": \"\",\n \"globalBillingPeriodicity\": \"01\",\n \"globalProductId\": \"\",\n \"globalBranchId\": \"\",\n \"globalCustomerId\": \"\",\n \"defaultPaymentMethodId\": \"\",\n \"certificateId\": \"\",\n \"certificatePassword\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "c563ec4f-51b8-43c7-a073-098d3a2f50de", "name": "Configuration created or updated", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "sat-mexico-configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"active\": \"\",\n \"companyId\": \"\",\n \"pacType\": \"FINKOK\",\n \"testMode\": \"\",\n \"pacUser\": \"\",\n \"pacPassword\": \"\",\n \"licenceId\": \"\",\n \"syncInvoices\": \"\",\n \"syncIncomingPayments\": \"\",\n \"syncCreditNotes\": \"\",\n \"syncPaymentCancel\": \"\",\n \"hoursBlockedAfterRejectedCancellation\": \"\",\n \"hoursBeforeReinvoicing\": \"\",\n \"globalBillingPerCompany\": \"\",\n \"globalPerTicket\": \"\",\n \"globalDetailedPerLine\": \"\",\n \"globalBillingPeriodicity\": \"01\",\n \"globalProductId\": \"\",\n \"globalBranchId\": \"\",\n \"globalCustomerId\": \"\",\n \"defaultPaymentMethodId\": \"\",\n \"certificateId\": \"\",\n \"certificatePassword\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"active\": \"\",\n \"companyId\": \"\",\n \"pacType\": \"CONTPAQ\",\n \"testMode\": \"\",\n \"pacUser\": \"\",\n \"syncInvoices\": \"\",\n \"syncIncomingPayments\": \"\",\n \"syncCreditNotes\": \"\",\n \"syncPaymentCancel\": \"\",\n \"hoursBlockedAfterRejectedCancellation\": \"\",\n \"hoursBeforeReinvoicing\": \"\",\n \"globalBillingPerCompany\": \"\",\n \"globalPerTicket\": \"\",\n \"globalDetailedPerLine\": \"\",\n \"globalBillingPeriodicity\": \"05\",\n \"globalProductId\": \"\",\n \"globalBranchId\": \"\",\n \"globalCustomerId\": \"\",\n \"defaultPaymentMethodId\": \"\",\n \"certificateId\": \"\",\n \"certificateName\": \"\",\n \"certificateKeyName\": \"\",\n \"certificateHolderName\": \"\",\n \"certificateIssuerName\": \"\",\n \"certificateSerialNumber\": \"\",\n \"certificateValidFrom\": \"\",\n \"certificateValidTo\": \"\",\n \"certificateUploadedAt\": \"\",\n \"version\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "98a4684c-0b60-43b4-afc2-11795d056a74", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "sat-mexico-configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"active\": \"\",\n \"companyId\": \"\",\n \"pacType\": \"FINKOK\",\n \"testMode\": \"\",\n \"pacUser\": \"\",\n \"pacPassword\": \"\",\n \"licenceId\": \"\",\n \"syncInvoices\": \"\",\n \"syncIncomingPayments\": \"\",\n \"syncCreditNotes\": \"\",\n \"syncPaymentCancel\": \"\",\n \"hoursBlockedAfterRejectedCancellation\": \"\",\n \"hoursBeforeReinvoicing\": \"\",\n \"globalBillingPerCompany\": \"\",\n \"globalPerTicket\": \"\",\n \"globalDetailedPerLine\": \"\",\n \"globalBillingPeriodicity\": \"01\",\n \"globalProductId\": \"\",\n \"globalBranchId\": \"\",\n \"globalCustomerId\": \"\",\n \"defaultPaymentMethodId\": \"\",\n \"certificateId\": \"\",\n \"certificatePassword\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b1a79a3d-4ab4-412d-9c90-cd3c0ffee28e", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "sat-mexico-configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"active\": \"\",\n \"companyId\": \"\",\n \"pacType\": \"FINKOK\",\n \"testMode\": \"\",\n \"pacUser\": \"\",\n \"pacPassword\": \"\",\n \"licenceId\": \"\",\n \"syncInvoices\": \"\",\n \"syncIncomingPayments\": \"\",\n \"syncCreditNotes\": \"\",\n \"syncPaymentCancel\": \"\",\n \"hoursBlockedAfterRejectedCancellation\": \"\",\n \"hoursBeforeReinvoicing\": \"\",\n \"globalBillingPerCompany\": \"\",\n \"globalPerTicket\": \"\",\n \"globalDetailedPerLine\": \"\",\n \"globalBillingPeriodicity\": \"01\",\n \"globalProductId\": \"\",\n \"globalBranchId\": \"\",\n \"globalCustomerId\": \"\",\n \"defaultPaymentMethodId\": \"\",\n \"certificateId\": \"\",\n \"certificatePassword\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0cb9da5e-8146-49a2-a3cf-995326d2c5a7", "name": "Missing EDITAR_CONFIGURACIONSATMEXICO permission", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "sat-mexico-configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"active\": \"\",\n \"companyId\": \"\",\n \"pacType\": \"FINKOK\",\n \"testMode\": \"\",\n \"pacUser\": \"\",\n \"pacPassword\": \"\",\n \"licenceId\": \"\",\n \"syncInvoices\": \"\",\n \"syncIncomingPayments\": \"\",\n \"syncCreditNotes\": \"\",\n \"syncPaymentCancel\": \"\",\n \"hoursBlockedAfterRejectedCancellation\": \"\",\n \"hoursBeforeReinvoicing\": \"\",\n \"globalBillingPerCompany\": \"\",\n \"globalPerTicket\": \"\",\n \"globalDetailedPerLine\": \"\",\n \"globalBillingPeriodicity\": \"01\",\n \"globalProductId\": \"\",\n \"globalBranchId\": \"\",\n \"globalCustomerId\": \"\",\n \"defaultPaymentMethodId\": \"\",\n \"certificateId\": \"\",\n \"certificatePassword\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2b8f5a0a-0369-4482-b660-72b74c69dcf7", "name": "Company is outside the authenticated scope", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "sat-mexico-configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"active\": \"\",\n \"companyId\": \"\",\n \"pacType\": \"FINKOK\",\n \"testMode\": \"\",\n \"pacUser\": \"\",\n \"pacPassword\": \"\",\n \"licenceId\": \"\",\n \"syncInvoices\": \"\",\n \"syncIncomingPayments\": \"\",\n \"syncCreditNotes\": \"\",\n \"syncPaymentCancel\": \"\",\n \"hoursBlockedAfterRejectedCancellation\": \"\",\n \"hoursBeforeReinvoicing\": \"\",\n \"globalBillingPerCompany\": \"\",\n \"globalPerTicket\": \"\",\n \"globalDetailedPerLine\": \"\",\n \"globalBillingPeriodicity\": \"01\",\n \"globalProductId\": \"\",\n \"globalBranchId\": \"\",\n \"globalCustomerId\": \"\",\n \"defaultPaymentMethodId\": \"\",\n \"certificateId\": \"\",\n \"certificatePassword\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7b53094e-0dad-4a9a-8c1b-9c125d5005d4", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "sat-mexico-configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"active\": \"\",\n \"companyId\": \"\",\n \"pacType\": \"FINKOK\",\n \"testMode\": \"\",\n \"pacUser\": \"\",\n \"pacPassword\": \"\",\n \"licenceId\": \"\",\n \"syncInvoices\": \"\",\n \"syncIncomingPayments\": \"\",\n \"syncCreditNotes\": \"\",\n \"syncPaymentCancel\": \"\",\n \"hoursBlockedAfterRejectedCancellation\": \"\",\n \"hoursBeforeReinvoicing\": \"\",\n \"globalBillingPerCompany\": \"\",\n \"globalPerTicket\": \"\",\n \"globalDetailedPerLine\": \"\",\n \"globalBillingPeriodicity\": \"01\",\n \"globalProductId\": \"\",\n \"globalBranchId\": \"\",\n \"globalCustomerId\": \"\",\n \"defaultPaymentMethodId\": \"\",\n \"certificateId\": \"\",\n \"certificatePassword\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2cb5ddcc-6f51-44ef-84f6-2386a667f401", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "sat-mexico-configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"active\": \"\",\n \"companyId\": \"\",\n \"pacType\": \"FINKOK\",\n \"testMode\": \"\",\n \"pacUser\": \"\",\n \"pacPassword\": \"\",\n \"licenceId\": \"\",\n \"syncInvoices\": \"\",\n \"syncIncomingPayments\": \"\",\n \"syncCreditNotes\": \"\",\n \"syncPaymentCancel\": \"\",\n \"hoursBlockedAfterRejectedCancellation\": \"\",\n \"hoursBeforeReinvoicing\": \"\",\n \"globalBillingPerCompany\": \"\",\n \"globalPerTicket\": \"\",\n \"globalDetailedPerLine\": \"\",\n \"globalBillingPeriodicity\": \"01\",\n \"globalProductId\": \"\",\n \"globalBranchId\": \"\",\n \"globalCustomerId\": \"\",\n \"defaultPaymentMethodId\": \"\",\n \"certificateId\": \"\",\n \"certificatePassword\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "new", "description": "", "item": [ { "id": "17a31d5a-107d-414b-a2f6-b8f81fdb4381", "name": "Prototype a Mexico SAT configuration", "request": { "name": "Prototype a Mexico SAT configuration", "description": { "content": "Returns form defaults and does not persist a configuration.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "companies", ":companyId", "sat-mexico-configuration", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "companyId", "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "8a66a0e3-fa31-44b2-a62c-b22e93c30cf3", "name": "Non-persistent prototype", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "sat-mexico-configuration", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"active\": \"\",\n \"companyId\": \"\",\n \"pacType\": \"CONTPAQ\",\n \"testMode\": \"\",\n \"pacUser\": \"\",\n \"syncInvoices\": \"\",\n \"syncIncomingPayments\": \"\",\n \"syncCreditNotes\": \"\",\n \"syncPaymentCancel\": \"\",\n \"hoursBlockedAfterRejectedCancellation\": \"\",\n \"hoursBeforeReinvoicing\": \"\",\n \"globalBillingPerCompany\": \"\",\n \"globalPerTicket\": \"\",\n \"globalDetailedPerLine\": \"\",\n \"globalBillingPeriodicity\": \"05\",\n \"globalProductId\": \"\",\n \"globalBranchId\": \"\",\n \"globalCustomerId\": \"\",\n \"defaultPaymentMethodId\": \"\",\n \"certificateId\": \"\",\n \"certificateName\": \"\",\n \"certificateKeyName\": \"\",\n \"certificateHolderName\": \"\",\n \"certificateIssuerName\": \"\",\n \"certificateSerialNumber\": \"\",\n \"certificateValidFrom\": \"\",\n \"certificateValidTo\": \"\",\n \"certificateUploadedAt\": \"\",\n \"version\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "06a7a8c9-a4a3-4377-9460-47e7b746f559", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "sat-mexico-configuration", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "df271f22-f51d-4c4e-aef0-72b710ce2199", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "sat-mexico-configuration", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9ae898b3-c65e-4553-812e-440bf2326e8d", "name": "Missing EDITAR_CONFIGURACIONSATMEXICO permission", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "sat-mexico-configuration", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ca68aebc-a638-4af2-b2f0-2b02e43b141f", "name": "Company is outside the authenticated scope", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "sat-mexico-configuration", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7006cc3c-79a8-4217-b99d-8b6e94377e3d", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "sat-mexico-configuration", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "certificate", "description": "", "item": [ { "id": "63bfd5b8-297c-41d9-a149-fcae8be30d79", "name": "Upload and validate the company CSD certificate (.cer)", "request": { "name": "Upload and validate the company CSD certificate (.cer)", "description": { "content": "Stages a .cer file and returns an opaque certificateId. Upload the matching .key via /certificate-key before PUT.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "companies", ":companyId", "sat-mexico-configuration", "certificate" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Replace an already staged certificate", "type": "text/plain" }, "key": "replace", "value": "true" } ], "variable": [ { "type": "any", "value": "", "key": "companyId", "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) CSD certificate (.cer)", "type": "text/plain" }, "key": "file", "type": "file" } ] }, "auth": null }, "response": [ { "id": "f547333a-eb34-4821-93e6-132bcdc7bcd3", "name": "Certificate validated and staged", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "sat-mexico-configuration", "certificate" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Replace an already staged certificate", "type": "text/plain" }, "key": "replace", "value": "true" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) CSD certificate (.cer)", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"certificateId\": \"\",\n \"certificateName\": \"\",\n \"certificateHolderName\": \"\",\n \"certificateIssuerName\": \"\",\n \"certificateSerialNumber\": \"\",\n \"certificateValidFrom\": \"\",\n \"certificateValidTo\": \"\",\n \"certificateUploadedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "dbb877f6-f18c-4328-8dbc-98df21ffe663", "name": "Missing, invalid or oversized .cer", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "sat-mexico-configuration", "certificate" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Replace an already staged certificate", "type": "text/plain" }, "key": "replace", "value": "true" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) CSD certificate (.cer)", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2e03c271-0c9b-437d-a573-f46406f63507", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "sat-mexico-configuration", "certificate" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Replace an already staged certificate", "type": "text/plain" }, "key": "replace", "value": "true" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) CSD certificate (.cer)", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a2171357-6d02-4246-95d9-2522e9c62c6a", "name": "Missing EDITAR_CONFIGURACIONSATMEXICO permission", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "sat-mexico-configuration", "certificate" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Replace an already staged certificate", "type": "text/plain" }, "key": "replace", "value": "true" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) CSD certificate (.cer)", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "48e29fed-c91a-4443-8743-362694ea8cf9", "name": "Company is outside the authenticated scope", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "sat-mexico-configuration", "certificate" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Replace an already staged certificate", "type": "text/plain" }, "key": "replace", "value": "true" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) CSD certificate (.cer)", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a3ff9188-ccd4-4fc3-b40e-1f7d5a1cea62", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "sat-mexico-configuration", "certificate" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Replace an already staged certificate", "type": "text/plain" }, "key": "replace", "value": "true" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) CSD certificate (.cer)", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "certificate-key", "description": "", "item": [ { "id": "c86f017c-1a90-4d17-aae6-af8beb555b22", "name": "Upload the company CSD private key (.key)", "request": { "name": "Upload the company CSD private key (.key)", "description": { "content": "Stages the .key file for a previously uploaded certificateId.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "companies", ":companyId", "sat-mexico-configuration", "certificate-key" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) certificateId returned by /certificate", "type": "text/plain" }, "key": "certificateId", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "companyId", "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) CSD private key (.key)", "type": "text/plain" }, "key": "file", "type": "file" } ] }, "auth": null }, "response": [ { "id": "6f316ed8-35b9-45ed-b1ed-f58590146589", "name": "Private key staged", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "sat-mexico-configuration", "certificate-key" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) certificateId returned by /certificate", "type": "text/plain" }, "key": "certificateId", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) CSD private key (.key)", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"certificateId\": \"\",\n \"certificateKeyName\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cc387e03-d726-48e0-a7e0-6498999d3e1d", "name": "Missing certificateId or invalid/oversized .key", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "sat-mexico-configuration", "certificate-key" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) certificateId returned by /certificate", "type": "text/plain" }, "key": "certificateId", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) CSD private key (.key)", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4ec2fd23-9d74-4852-b429-fb13c5b1d80a", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "sat-mexico-configuration", "certificate-key" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) certificateId returned by /certificate", "type": "text/plain" }, "key": "certificateId", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) CSD private key (.key)", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fe12fc82-0623-4369-82d4-3af826d2d488", "name": "Missing EDITAR_CONFIGURACIONSATMEXICO permission", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "sat-mexico-configuration", "certificate-key" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) certificateId returned by /certificate", "type": "text/plain" }, "key": "certificateId", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) CSD private key (.key)", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "83082f85-334f-4f31-8601-b2fe01cea797", "name": "Company is outside the authenticated scope", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "sat-mexico-configuration", "certificate-key" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) certificateId returned by /certificate", "type": "text/plain" }, "key": "certificateId", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) CSD private key (.key)", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "786e8aa5-c100-4218-8d1f-33e577eac82c", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "sat-mexico-configuration", "certificate-key" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) certificateId returned by /certificate", "type": "text/plain" }, "key": "certificateId", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) CSD private key (.key)", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "document-control-configuration", "description": "", "item": [ { "id": "627f677c-65c8-4ee2-8fa4-d94e7bc0a02b", "name": "Get the company document control configuration", "request": { "name": "Get the company document control configuration", "description": { "content": "Returns the singleton configuration and its ETag. A company without a persisted configuration returns 404.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "companies", ":companyId", "document-control-configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "companyId", "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "4678b0f1-e7ef-4ac2-8f2e-4dd350e87260", "name": "Configuration found", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "document-control-configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"companyId\": \"\",\n \"id\": \"\",\n \"enableOrderPaymentControl\": \"\",\n \"orderCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"orderMinimumChargedPercentage\": \"\",\n \"enableInvoicePaymentControl\": \"\",\n \"invoiceCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"invoiceMinimumChargedPercentage\": \"\",\n \"enableTicketPaymentControl\": \"\",\n \"ticketCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"ticketMinimumChargedPercentage\": \"\",\n \"enableSalesPaymentControl\": \"\",\n \"salesMinimumChargedPercentage\": \"\",\n \"forceFullPaymentOnInvoiceDelivery\": \"\",\n \"blockFullChargeOnOrders\": \"\",\n \"orderExpirationDays\": \"\",\n \"quoteExpirationDays\": \"\",\n \"blockOphthalmicLensLineSales\": \"\",\n \"blockOrdersAfterSupplierRequest\": \"\",\n \"headOfficeCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"supplierFrameCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"allowNewOrdersOnInvoicesFromOrders\": \"\",\n \"forceFullDeliveryOnInvoicesFromOrders\": \"\",\n \"enableItemControlOnInvoicesFromOrders\": \"\",\n \"changeableOrderInvoiceCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"enableRepairArticleControl\": \"\",\n \"repairCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"version\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "448b3fe2-e31e-4fc9-a219-65c2eb64c248", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "document-control-configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cdb2f471-2d2a-411d-9f86-7d9765294ca3", "name": "Missing EDITAR_EMPRESAS permission", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "document-control-configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d7d3a89e-6d1d-47c7-8b22-464b0f130215", "name": "Company is outside scope or configuration does not exist", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "document-control-configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f84bda1b-abd2-414f-b98c-0674210c840d", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "document-control-configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8ecc1858-a166-4192-bf78-dd32de48e4e9", "name": "Upsert the company document control configuration", "request": { "name": "Upsert the company document control configuration", "description": { "content": "Creates or partially updates the singleton configuration. Omitted or null scalar fields are left unchanged. Category lists omitted or null are left unchanged; send an empty array to clear a list. When a payment-control flag is true, the corresponding minimum charged percentage must be present in the final stored state. Category IDs must belong to companyId. Use If-Match with the ETag from GET for optimistic locking on updates.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "companies", ":companyId", "document-control-configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "companyId", "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"companyId\": \"\",\n \"enableOrderPaymentControl\": \"\",\n \"orderCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"orderMinimumChargedPercentage\": \"\",\n \"enableInvoicePaymentControl\": \"\",\n \"invoiceCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"invoiceMinimumChargedPercentage\": \"\",\n \"enableTicketPaymentControl\": \"\",\n \"ticketCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"ticketMinimumChargedPercentage\": \"\",\n \"enableSalesPaymentControl\": \"\",\n \"salesMinimumChargedPercentage\": \"\",\n \"forceFullPaymentOnInvoiceDelivery\": \"\",\n \"blockFullChargeOnOrders\": \"\",\n \"orderExpirationDays\": \"\",\n \"quoteExpirationDays\": \"\",\n \"blockOphthalmicLensLineSales\": \"\",\n \"blockOrdersAfterSupplierRequest\": \"\",\n \"headOfficeCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"supplierFrameCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"allowNewOrdersOnInvoicesFromOrders\": \"\",\n \"forceFullDeliveryOnInvoicesFromOrders\": \"\",\n \"enableItemControlOnInvoicesFromOrders\": \"\",\n \"changeableOrderInvoiceCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"enableRepairArticleControl\": \"\",\n \"repairCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "15c4ff55-0133-4ee2-a5d5-e72a12332375", "name": "Configuration created or updated", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "document-control-configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"companyId\": \"\",\n \"enableOrderPaymentControl\": \"\",\n \"orderCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"orderMinimumChargedPercentage\": \"\",\n \"enableInvoicePaymentControl\": \"\",\n \"invoiceCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"invoiceMinimumChargedPercentage\": \"\",\n \"enableTicketPaymentControl\": \"\",\n \"ticketCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"ticketMinimumChargedPercentage\": \"\",\n \"enableSalesPaymentControl\": \"\",\n \"salesMinimumChargedPercentage\": \"\",\n \"forceFullPaymentOnInvoiceDelivery\": \"\",\n \"blockFullChargeOnOrders\": \"\",\n \"orderExpirationDays\": \"\",\n \"quoteExpirationDays\": \"\",\n \"blockOphthalmicLensLineSales\": \"\",\n \"blockOrdersAfterSupplierRequest\": \"\",\n \"headOfficeCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"supplierFrameCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"allowNewOrdersOnInvoicesFromOrders\": \"\",\n \"forceFullDeliveryOnInvoicesFromOrders\": \"\",\n \"enableItemControlOnInvoicesFromOrders\": \"\",\n \"changeableOrderInvoiceCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"enableRepairArticleControl\": \"\",\n \"repairCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"companyId\": \"\",\n \"id\": \"\",\n \"enableOrderPaymentControl\": \"\",\n \"orderCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"orderMinimumChargedPercentage\": \"\",\n \"enableInvoicePaymentControl\": \"\",\n \"invoiceCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"invoiceMinimumChargedPercentage\": \"\",\n \"enableTicketPaymentControl\": \"\",\n \"ticketCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"ticketMinimumChargedPercentage\": \"\",\n \"enableSalesPaymentControl\": \"\",\n \"salesMinimumChargedPercentage\": \"\",\n \"forceFullPaymentOnInvoiceDelivery\": \"\",\n \"blockFullChargeOnOrders\": \"\",\n \"orderExpirationDays\": \"\",\n \"quoteExpirationDays\": \"\",\n \"blockOphthalmicLensLineSales\": \"\",\n \"blockOrdersAfterSupplierRequest\": \"\",\n \"headOfficeCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"supplierFrameCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"allowNewOrdersOnInvoicesFromOrders\": \"\",\n \"forceFullDeliveryOnInvoicesFromOrders\": \"\",\n \"enableItemControlOnInvoicesFromOrders\": \"\",\n \"changeableOrderInvoiceCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"enableRepairArticleControl\": \"\",\n \"repairCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"version\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "76b7f2e1-95de-4170-a062-a1a5eb39b168", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "document-control-configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"companyId\": \"\",\n \"enableOrderPaymentControl\": \"\",\n \"orderCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"orderMinimumChargedPercentage\": \"\",\n \"enableInvoicePaymentControl\": \"\",\n \"invoiceCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"invoiceMinimumChargedPercentage\": \"\",\n \"enableTicketPaymentControl\": \"\",\n \"ticketCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"ticketMinimumChargedPercentage\": \"\",\n \"enableSalesPaymentControl\": \"\",\n \"salesMinimumChargedPercentage\": \"\",\n \"forceFullPaymentOnInvoiceDelivery\": \"\",\n \"blockFullChargeOnOrders\": \"\",\n \"orderExpirationDays\": \"\",\n \"quoteExpirationDays\": \"\",\n \"blockOphthalmicLensLineSales\": \"\",\n \"blockOrdersAfterSupplierRequest\": \"\",\n \"headOfficeCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"supplierFrameCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"allowNewOrdersOnInvoicesFromOrders\": \"\",\n \"forceFullDeliveryOnInvoicesFromOrders\": \"\",\n \"enableItemControlOnInvoicesFromOrders\": \"\",\n \"changeableOrderInvoiceCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"enableRepairArticleControl\": \"\",\n \"repairCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d683fe7b-7eca-4f4f-970e-5bc5e928a066", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "document-control-configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"companyId\": \"\",\n \"enableOrderPaymentControl\": \"\",\n \"orderCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"orderMinimumChargedPercentage\": \"\",\n \"enableInvoicePaymentControl\": \"\",\n \"invoiceCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"invoiceMinimumChargedPercentage\": \"\",\n \"enableTicketPaymentControl\": \"\",\n \"ticketCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"ticketMinimumChargedPercentage\": \"\",\n \"enableSalesPaymentControl\": \"\",\n \"salesMinimumChargedPercentage\": \"\",\n \"forceFullPaymentOnInvoiceDelivery\": \"\",\n \"blockFullChargeOnOrders\": \"\",\n \"orderExpirationDays\": \"\",\n \"quoteExpirationDays\": \"\",\n \"blockOphthalmicLensLineSales\": \"\",\n \"blockOrdersAfterSupplierRequest\": \"\",\n \"headOfficeCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"supplierFrameCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"allowNewOrdersOnInvoicesFromOrders\": \"\",\n \"forceFullDeliveryOnInvoicesFromOrders\": \"\",\n \"enableItemControlOnInvoicesFromOrders\": \"\",\n \"changeableOrderInvoiceCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"enableRepairArticleControl\": \"\",\n \"repairCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3663683d-cb0c-48d9-9d77-35b2c8838f6f", "name": "Missing EDITAR_EMPRESAS permission", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "document-control-configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"companyId\": \"\",\n \"enableOrderPaymentControl\": \"\",\n \"orderCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"orderMinimumChargedPercentage\": \"\",\n \"enableInvoicePaymentControl\": \"\",\n \"invoiceCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"invoiceMinimumChargedPercentage\": \"\",\n \"enableTicketPaymentControl\": \"\",\n \"ticketCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"ticketMinimumChargedPercentage\": \"\",\n \"enableSalesPaymentControl\": \"\",\n \"salesMinimumChargedPercentage\": \"\",\n \"forceFullPaymentOnInvoiceDelivery\": \"\",\n \"blockFullChargeOnOrders\": \"\",\n \"orderExpirationDays\": \"\",\n \"quoteExpirationDays\": \"\",\n \"blockOphthalmicLensLineSales\": \"\",\n \"blockOrdersAfterSupplierRequest\": \"\",\n \"headOfficeCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"supplierFrameCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"allowNewOrdersOnInvoicesFromOrders\": \"\",\n \"forceFullDeliveryOnInvoicesFromOrders\": \"\",\n \"enableItemControlOnInvoicesFromOrders\": \"\",\n \"changeableOrderInvoiceCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"enableRepairArticleControl\": \"\",\n \"repairCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d55a3afd-ecbc-4048-83d7-9b0285194c8f", "name": "Company is outside the authenticated scope", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "document-control-configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"companyId\": \"\",\n \"enableOrderPaymentControl\": \"\",\n \"orderCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"orderMinimumChargedPercentage\": \"\",\n \"enableInvoicePaymentControl\": \"\",\n \"invoiceCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"invoiceMinimumChargedPercentage\": \"\",\n \"enableTicketPaymentControl\": \"\",\n \"ticketCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"ticketMinimumChargedPercentage\": \"\",\n \"enableSalesPaymentControl\": \"\",\n \"salesMinimumChargedPercentage\": \"\",\n \"forceFullPaymentOnInvoiceDelivery\": \"\",\n \"blockFullChargeOnOrders\": \"\",\n \"orderExpirationDays\": \"\",\n \"quoteExpirationDays\": \"\",\n \"blockOphthalmicLensLineSales\": \"\",\n \"blockOrdersAfterSupplierRequest\": \"\",\n \"headOfficeCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"supplierFrameCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"allowNewOrdersOnInvoicesFromOrders\": \"\",\n \"forceFullDeliveryOnInvoicesFromOrders\": \"\",\n \"enableItemControlOnInvoicesFromOrders\": \"\",\n \"changeableOrderInvoiceCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"enableRepairArticleControl\": \"\",\n \"repairCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9aa3a97c-ec4f-47a3-b4d9-e793eb73c732", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "document-control-configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"companyId\": \"\",\n \"enableOrderPaymentControl\": \"\",\n \"orderCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"orderMinimumChargedPercentage\": \"\",\n \"enableInvoicePaymentControl\": \"\",\n \"invoiceCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"invoiceMinimumChargedPercentage\": \"\",\n \"enableTicketPaymentControl\": \"\",\n \"ticketCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"ticketMinimumChargedPercentage\": \"\",\n \"enableSalesPaymentControl\": \"\",\n \"salesMinimumChargedPercentage\": \"\",\n \"forceFullPaymentOnInvoiceDelivery\": \"\",\n \"blockFullChargeOnOrders\": \"\",\n \"orderExpirationDays\": \"\",\n \"quoteExpirationDays\": \"\",\n \"blockOphthalmicLensLineSales\": \"\",\n \"blockOrdersAfterSupplierRequest\": \"\",\n \"headOfficeCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"supplierFrameCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"allowNewOrdersOnInvoicesFromOrders\": \"\",\n \"forceFullDeliveryOnInvoicesFromOrders\": \"\",\n \"enableItemControlOnInvoicesFromOrders\": \"\",\n \"changeableOrderInvoiceCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"enableRepairArticleControl\": \"\",\n \"repairCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fd7d91db-1653-485e-ae37-7fd3722b67cd", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "document-control-configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"companyId\": \"\",\n \"enableOrderPaymentControl\": \"\",\n \"orderCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"orderMinimumChargedPercentage\": \"\",\n \"enableInvoicePaymentControl\": \"\",\n \"invoiceCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"invoiceMinimumChargedPercentage\": \"\",\n \"enableTicketPaymentControl\": \"\",\n \"ticketCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"ticketMinimumChargedPercentage\": \"\",\n \"enableSalesPaymentControl\": \"\",\n \"salesMinimumChargedPercentage\": \"\",\n \"forceFullPaymentOnInvoiceDelivery\": \"\",\n \"blockFullChargeOnOrders\": \"\",\n \"orderExpirationDays\": \"\",\n \"quoteExpirationDays\": \"\",\n \"blockOphthalmicLensLineSales\": \"\",\n \"blockOrdersAfterSupplierRequest\": \"\",\n \"headOfficeCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"supplierFrameCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"allowNewOrdersOnInvoicesFromOrders\": \"\",\n \"forceFullDeliveryOnInvoicesFromOrders\": \"\",\n \"enableItemControlOnInvoicesFromOrders\": \"\",\n \"changeableOrderInvoiceCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"enableRepairArticleControl\": \"\",\n \"repairCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "new", "description": "", "item": [ { "id": "0cab36ac-734f-49e9-81ba-d612d9dc5caa", "name": "Prototype a document control configuration", "request": { "name": "Prototype a document control configuration", "description": { "content": "Returns non-persistent form defaults for a company that may not have a configuration row yet. Does not write to the database. Typical create flow: POST /new, then PUT / to persist.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "companies", ":companyId", "document-control-configuration", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "companyId", "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "4cdb23dc-f9bd-4a80-abd8-74347d69f558", "name": "Non-persistent prototype", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "document-control-configuration", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"companyId\": \"\",\n \"id\": \"\",\n \"enableOrderPaymentControl\": \"\",\n \"orderCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"orderMinimumChargedPercentage\": \"\",\n \"enableInvoicePaymentControl\": \"\",\n \"invoiceCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"invoiceMinimumChargedPercentage\": \"\",\n \"enableTicketPaymentControl\": \"\",\n \"ticketCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"ticketMinimumChargedPercentage\": \"\",\n \"enableSalesPaymentControl\": \"\",\n \"salesMinimumChargedPercentage\": \"\",\n \"forceFullPaymentOnInvoiceDelivery\": \"\",\n \"blockFullChargeOnOrders\": \"\",\n \"orderExpirationDays\": \"\",\n \"quoteExpirationDays\": \"\",\n \"blockOphthalmicLensLineSales\": \"\",\n \"blockOrdersAfterSupplierRequest\": \"\",\n \"headOfficeCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"supplierFrameCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"allowNewOrdersOnInvoicesFromOrders\": \"\",\n \"forceFullDeliveryOnInvoicesFromOrders\": \"\",\n \"enableItemControlOnInvoicesFromOrders\": \"\",\n \"changeableOrderInvoiceCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"enableRepairArticleControl\": \"\",\n \"repairCategories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"version\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b075694d-a661-4f37-9f15-591aed5e5d03", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "document-control-configuration", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "de9748c1-5327-4a0d-bf8b-454de886ef6c", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "document-control-configuration", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "53fdc076-4b99-4795-89ee-1390577c3aff", "name": "Missing EDITAR_EMPRESAS permission", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "document-control-configuration", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "34d1ee3e-8884-4f26-ba0d-a1a443150068", "name": "Company is outside the authenticated scope", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "document-control-configuration", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "09f60b5d-a316-438e-a00f-887f91d14e71", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "document-control-configuration", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "chile-sii-configuration", "description": "", "item": [ { "id": "b4238e01-a2dd-4aa9-973b-bac5f2bcf7be", "name": "Get the company Chile SII configuration", "request": { "name": "Get the company Chile SII configuration", "description": { "content": "Returns the singleton configuration and its ETag. A company without a completed configuration returns 404.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "companies", ":companyId", "chile-sii-configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "companyId", "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "a1450668-183f-4b30-a067-7bed505fb6c0", "name": "Configuration found", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "chile-sii-configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"active\": \"\",\n \"companyId\": \"\",\n \"testMode\": \"\",\n \"autoSync\": \"\",\n \"syncReceipts\": \"\",\n \"syncInvoices\": \"\",\n \"syncExemptInvoices\": \"\",\n \"syncDeliveryNotes\": \"\",\n \"syncInternalDeliveryNotes\": \"\",\n \"syncCreditNotes\": \"\",\n \"syncDebitNotes\": \"\",\n \"syncPurchaseInvoices\": \"\",\n \"syncExportInvoices\": \"\",\n \"syncExportCreditNotes\": \"\",\n \"syncExportDebitNotes\": \"\",\n \"syncExemptReceipts\": \"\",\n \"syncMailCheck\": \"\",\n \"syncMailSend\": \"\",\n \"companyTaxId\": \"\",\n \"senderRut\": \"\",\n \"recipientRut\": \"\",\n \"verificationCode\": \"\",\n \"resolutionDate\": \"\",\n \"resolutionNumber\": \"\",\n \"defaultBranchId\": \"\",\n \"genericProductId\": \"\",\n \"certificateId\": \"\",\n \"certificateName\": \"\",\n \"certificateFingerprint\": \"\",\n \"certificateExpiresAt\": \"\",\n \"certificateUploadedAt\": \"\",\n \"certificateTaxIdWarning\": \"\",\n \"mailHost\": \"\",\n \"mailPort\": \"\",\n \"mailStoreProtocol\": \"\",\n \"mailUser\": \"\",\n \"receiptsCaf\": {\n \"fileName\": \"\",\n \"folioStart\": \"\",\n \"folioEnd\": \"\",\n \"validUntil\": \"\"\n },\n \"invoicesCaf\": {\n \"fileName\": \"\",\n \"folioStart\": \"\",\n \"folioEnd\": \"\",\n \"validUntil\": \"\"\n },\n \"exemptInvoicesCaf\": {\n \"fileName\": \"\",\n \"folioStart\": \"\",\n \"folioEnd\": \"\",\n \"validUntil\": \"\"\n },\n \"deliveryNotesCaf\": {\n \"fileName\": \"\",\n \"folioStart\": \"\",\n \"folioEnd\": \"\",\n \"validUntil\": \"\"\n },\n \"creditNotesCaf\": {\n \"fileName\": \"\",\n \"folioStart\": \"\",\n \"folioEnd\": \"\",\n \"validUntil\": \"\"\n },\n \"debitNotesCaf\": {\n \"fileName\": \"\",\n \"folioStart\": \"\",\n \"folioEnd\": \"\",\n \"validUntil\": \"\"\n },\n \"exemptReceiptsCaf\": {\n \"fileName\": \"\",\n \"folioStart\": \"\",\n \"folioEnd\": \"\",\n \"validUntil\": \"\"\n },\n \"purchaseInvoicesCaf\": {\n \"fileName\": \"\",\n \"folioStart\": \"\",\n \"folioEnd\": \"\",\n \"validUntil\": \"\"\n },\n \"exportInvoicesCaf\": {\n \"fileName\": \"\",\n \"folioStart\": \"\",\n \"folioEnd\": \"\",\n \"validUntil\": \"\"\n },\n \"exportCreditNotesCaf\": {\n \"fileName\": \"\",\n \"folioStart\": \"\",\n \"folioEnd\": \"\",\n \"validUntil\": \"\"\n },\n \"exportDebitNotesCaf\": {\n \"fileName\": \"\",\n \"folioStart\": \"\",\n \"folioEnd\": \"\",\n \"validUntil\": \"\"\n },\n \"version\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d8f2746b-0156-4445-a249-2b1e243d2961", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "chile-sii-configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d5cd25f3-8b44-430d-93e3-e7e0ea796376", "name": "Missing VER_CONFIGURACIONSIICHILE permission", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "chile-sii-configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e8a846f1-e490-4b3d-af0f-9ab4e6413898", "name": "Company is outside scope or configuration does not exist", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "chile-sii-configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c5a9978d-fd28-426b-86ac-f334fdbfbec4", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "chile-sii-configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "301abca1-e5a4-4f9f-a774-f10c4094f622", "name": "Upsert the company Chile SII configuration", "request": { "name": "Upsert the company Chile SII configuration", "description": { "content": "Atomically creates or replaces the singleton metadata. certificateId must reference a certificate uploaded for this company.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "companies", ":companyId", "chile-sii-configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "companyId", "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"active\": \"\",\n \"companyId\": \"\",\n \"testMode\": \"\",\n \"autoSync\": \"\",\n \"syncReceipts\": \"\",\n \"syncInvoices\": \"\",\n \"syncExemptInvoices\": \"\",\n \"syncDeliveryNotes\": \"\",\n \"syncInternalDeliveryNotes\": \"\",\n \"syncCreditNotes\": \"\",\n \"syncDebitNotes\": \"\",\n \"syncPurchaseInvoices\": \"\",\n \"syncExportInvoices\": \"\",\n \"syncExportCreditNotes\": \"\",\n \"syncExportDebitNotes\": \"\",\n \"syncExemptReceipts\": \"\",\n \"syncMailCheck\": \"\",\n \"syncMailSend\": \"\",\n \"companyTaxId\": \"\",\n \"senderRut\": \"\",\n \"recipientRut\": \"\",\n \"verificationCode\": \"\",\n \"resolutionDate\": \"\",\n \"resolutionNumber\": \"\",\n \"defaultBranchId\": \"\",\n \"genericProductId\": \"\",\n \"certificateId\": \"\",\n \"certificatePassword\": \"\",\n \"mailHost\": \"\",\n \"mailPassword\": \"\",\n \"mailPort\": \"\",\n \"mailStoreProtocol\": \"\",\n \"mailUser\": \"\",\n \"receiptsCaf\": {},\n \"invoicesCaf\": {},\n \"exemptInvoicesCaf\": {},\n \"deliveryNotesCaf\": {},\n \"creditNotesCaf\": {},\n \"debitNotesCaf\": {},\n \"exemptReceiptsCaf\": {},\n \"purchaseInvoicesCaf\": {},\n \"exportInvoicesCaf\": {},\n \"exportCreditNotesCaf\": {},\n \"exportDebitNotesCaf\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "2694e7d4-953a-4c0c-b325-0735e2af6085", "name": "Configuration created or updated", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "chile-sii-configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"active\": \"\",\n \"companyId\": \"\",\n \"testMode\": \"\",\n \"autoSync\": \"\",\n \"syncReceipts\": \"\",\n \"syncInvoices\": \"\",\n \"syncExemptInvoices\": \"\",\n \"syncDeliveryNotes\": \"\",\n \"syncInternalDeliveryNotes\": \"\",\n \"syncCreditNotes\": \"\",\n \"syncDebitNotes\": \"\",\n \"syncPurchaseInvoices\": \"\",\n \"syncExportInvoices\": \"\",\n \"syncExportCreditNotes\": \"\",\n \"syncExportDebitNotes\": \"\",\n \"syncExemptReceipts\": \"\",\n \"syncMailCheck\": \"\",\n \"syncMailSend\": \"\",\n \"companyTaxId\": \"\",\n \"senderRut\": \"\",\n \"recipientRut\": \"\",\n \"verificationCode\": \"\",\n \"resolutionDate\": \"\",\n \"resolutionNumber\": \"\",\n \"defaultBranchId\": \"\",\n \"genericProductId\": \"\",\n \"certificateId\": \"\",\n \"certificatePassword\": \"\",\n \"mailHost\": \"\",\n \"mailPassword\": \"\",\n \"mailPort\": \"\",\n \"mailStoreProtocol\": \"\",\n \"mailUser\": \"\",\n \"receiptsCaf\": {},\n \"invoicesCaf\": {},\n \"exemptInvoicesCaf\": {},\n \"deliveryNotesCaf\": {},\n \"creditNotesCaf\": {},\n \"debitNotesCaf\": {},\n \"exemptReceiptsCaf\": {},\n \"purchaseInvoicesCaf\": {},\n \"exportInvoicesCaf\": {},\n \"exportCreditNotesCaf\": {},\n \"exportDebitNotesCaf\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"active\": \"\",\n \"companyId\": \"\",\n \"testMode\": \"\",\n \"autoSync\": \"\",\n \"syncReceipts\": \"\",\n \"syncInvoices\": \"\",\n \"syncExemptInvoices\": \"\",\n \"syncDeliveryNotes\": \"\",\n \"syncInternalDeliveryNotes\": \"\",\n \"syncCreditNotes\": \"\",\n \"syncDebitNotes\": \"\",\n \"syncPurchaseInvoices\": \"\",\n \"syncExportInvoices\": \"\",\n \"syncExportCreditNotes\": \"\",\n \"syncExportDebitNotes\": \"\",\n \"syncExemptReceipts\": \"\",\n \"syncMailCheck\": \"\",\n \"syncMailSend\": \"\",\n \"companyTaxId\": \"\",\n \"senderRut\": \"\",\n \"recipientRut\": \"\",\n \"verificationCode\": \"\",\n \"resolutionDate\": \"\",\n \"resolutionNumber\": \"\",\n \"defaultBranchId\": \"\",\n \"genericProductId\": \"\",\n \"certificateId\": \"\",\n \"certificateName\": \"\",\n \"certificateFingerprint\": \"\",\n \"certificateExpiresAt\": \"\",\n \"certificateUploadedAt\": \"\",\n \"certificateTaxIdWarning\": \"\",\n \"mailHost\": \"\",\n \"mailPort\": \"\",\n \"mailStoreProtocol\": \"\",\n \"mailUser\": \"\",\n \"receiptsCaf\": {\n \"fileName\": \"\",\n \"folioStart\": \"\",\n \"folioEnd\": \"\",\n \"validUntil\": \"\"\n },\n \"invoicesCaf\": {\n \"fileName\": \"\",\n \"folioStart\": \"\",\n \"folioEnd\": \"\",\n \"validUntil\": \"\"\n },\n \"exemptInvoicesCaf\": {\n \"fileName\": \"\",\n \"folioStart\": \"\",\n \"folioEnd\": \"\",\n \"validUntil\": \"\"\n },\n \"deliveryNotesCaf\": {\n \"fileName\": \"\",\n \"folioStart\": \"\",\n \"folioEnd\": \"\",\n \"validUntil\": \"\"\n },\n \"creditNotesCaf\": {\n \"fileName\": \"\",\n \"folioStart\": \"\",\n \"folioEnd\": \"\",\n \"validUntil\": \"\"\n },\n \"debitNotesCaf\": {\n \"fileName\": \"\",\n \"folioStart\": \"\",\n \"folioEnd\": \"\",\n \"validUntil\": \"\"\n },\n \"exemptReceiptsCaf\": {\n \"fileName\": \"\",\n \"folioStart\": \"\",\n \"folioEnd\": \"\",\n \"validUntil\": \"\"\n },\n \"purchaseInvoicesCaf\": {\n \"fileName\": \"\",\n \"folioStart\": \"\",\n \"folioEnd\": \"\",\n \"validUntil\": \"\"\n },\n \"exportInvoicesCaf\": {\n \"fileName\": \"\",\n \"folioStart\": \"\",\n \"folioEnd\": \"\",\n \"validUntil\": \"\"\n },\n \"exportCreditNotesCaf\": {\n \"fileName\": \"\",\n \"folioStart\": \"\",\n \"folioEnd\": \"\",\n \"validUntil\": \"\"\n },\n \"exportDebitNotesCaf\": {\n \"fileName\": \"\",\n \"folioStart\": \"\",\n \"folioEnd\": \"\",\n \"validUntil\": \"\"\n },\n \"version\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "076ac3fd-7575-4e8b-a62d-3c7e1eee8c26", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "chile-sii-configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"active\": \"\",\n \"companyId\": \"\",\n \"testMode\": \"\",\n \"autoSync\": \"\",\n \"syncReceipts\": \"\",\n \"syncInvoices\": \"\",\n \"syncExemptInvoices\": \"\",\n \"syncDeliveryNotes\": \"\",\n \"syncInternalDeliveryNotes\": \"\",\n \"syncCreditNotes\": \"\",\n \"syncDebitNotes\": \"\",\n \"syncPurchaseInvoices\": \"\",\n \"syncExportInvoices\": \"\",\n \"syncExportCreditNotes\": \"\",\n \"syncExportDebitNotes\": \"\",\n \"syncExemptReceipts\": \"\",\n \"syncMailCheck\": \"\",\n \"syncMailSend\": \"\",\n \"companyTaxId\": \"\",\n \"senderRut\": \"\",\n \"recipientRut\": \"\",\n \"verificationCode\": \"\",\n \"resolutionDate\": \"\",\n \"resolutionNumber\": \"\",\n \"defaultBranchId\": \"\",\n \"genericProductId\": \"\",\n \"certificateId\": \"\",\n \"certificatePassword\": \"\",\n \"mailHost\": \"\",\n \"mailPassword\": \"\",\n \"mailPort\": \"\",\n \"mailStoreProtocol\": \"\",\n \"mailUser\": \"\",\n \"receiptsCaf\": {},\n \"invoicesCaf\": {},\n \"exemptInvoicesCaf\": {},\n \"deliveryNotesCaf\": {},\n \"creditNotesCaf\": {},\n \"debitNotesCaf\": {},\n \"exemptReceiptsCaf\": {},\n \"purchaseInvoicesCaf\": {},\n \"exportInvoicesCaf\": {},\n \"exportCreditNotesCaf\": {},\n \"exportDebitNotesCaf\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7c2166aa-5375-4a94-bd7b-a580718af857", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "chile-sii-configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"active\": \"\",\n \"companyId\": \"\",\n \"testMode\": \"\",\n \"autoSync\": \"\",\n \"syncReceipts\": \"\",\n \"syncInvoices\": \"\",\n \"syncExemptInvoices\": \"\",\n \"syncDeliveryNotes\": \"\",\n \"syncInternalDeliveryNotes\": \"\",\n \"syncCreditNotes\": \"\",\n \"syncDebitNotes\": \"\",\n \"syncPurchaseInvoices\": \"\",\n \"syncExportInvoices\": \"\",\n \"syncExportCreditNotes\": \"\",\n \"syncExportDebitNotes\": \"\",\n \"syncExemptReceipts\": \"\",\n \"syncMailCheck\": \"\",\n \"syncMailSend\": \"\",\n \"companyTaxId\": \"\",\n \"senderRut\": \"\",\n \"recipientRut\": \"\",\n \"verificationCode\": \"\",\n \"resolutionDate\": \"\",\n \"resolutionNumber\": \"\",\n \"defaultBranchId\": \"\",\n \"genericProductId\": \"\",\n \"certificateId\": \"\",\n \"certificatePassword\": \"\",\n \"mailHost\": \"\",\n \"mailPassword\": \"\",\n \"mailPort\": \"\",\n \"mailStoreProtocol\": \"\",\n \"mailUser\": \"\",\n \"receiptsCaf\": {},\n \"invoicesCaf\": {},\n \"exemptInvoicesCaf\": {},\n \"deliveryNotesCaf\": {},\n \"creditNotesCaf\": {},\n \"debitNotesCaf\": {},\n \"exemptReceiptsCaf\": {},\n \"purchaseInvoicesCaf\": {},\n \"exportInvoicesCaf\": {},\n \"exportCreditNotesCaf\": {},\n \"exportDebitNotesCaf\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a5438320-2c74-4c84-b87e-7019690ebc83", "name": "Missing EDITAR_CONFIGURACIONSIICHILE permission", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "chile-sii-configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"active\": \"\",\n \"companyId\": \"\",\n \"testMode\": \"\",\n \"autoSync\": \"\",\n \"syncReceipts\": \"\",\n \"syncInvoices\": \"\",\n \"syncExemptInvoices\": \"\",\n \"syncDeliveryNotes\": \"\",\n \"syncInternalDeliveryNotes\": \"\",\n \"syncCreditNotes\": \"\",\n \"syncDebitNotes\": \"\",\n \"syncPurchaseInvoices\": \"\",\n \"syncExportInvoices\": \"\",\n \"syncExportCreditNotes\": \"\",\n \"syncExportDebitNotes\": \"\",\n \"syncExemptReceipts\": \"\",\n \"syncMailCheck\": \"\",\n \"syncMailSend\": \"\",\n \"companyTaxId\": \"\",\n \"senderRut\": \"\",\n \"recipientRut\": \"\",\n \"verificationCode\": \"\",\n \"resolutionDate\": \"\",\n \"resolutionNumber\": \"\",\n \"defaultBranchId\": \"\",\n \"genericProductId\": \"\",\n \"certificateId\": \"\",\n \"certificatePassword\": \"\",\n \"mailHost\": \"\",\n \"mailPassword\": \"\",\n \"mailPort\": \"\",\n \"mailStoreProtocol\": \"\",\n \"mailUser\": \"\",\n \"receiptsCaf\": {},\n \"invoicesCaf\": {},\n \"exemptInvoicesCaf\": {},\n \"deliveryNotesCaf\": {},\n \"creditNotesCaf\": {},\n \"debitNotesCaf\": {},\n \"exemptReceiptsCaf\": {},\n \"purchaseInvoicesCaf\": {},\n \"exportInvoicesCaf\": {},\n \"exportCreditNotesCaf\": {},\n \"exportDebitNotesCaf\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0f37def9-2ff0-4e23-a5ec-4103866d1a7a", "name": "Company is outside the authenticated scope", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "chile-sii-configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"active\": \"\",\n \"companyId\": \"\",\n \"testMode\": \"\",\n \"autoSync\": \"\",\n \"syncReceipts\": \"\",\n \"syncInvoices\": \"\",\n \"syncExemptInvoices\": \"\",\n \"syncDeliveryNotes\": \"\",\n \"syncInternalDeliveryNotes\": \"\",\n \"syncCreditNotes\": \"\",\n \"syncDebitNotes\": \"\",\n \"syncPurchaseInvoices\": \"\",\n \"syncExportInvoices\": \"\",\n \"syncExportCreditNotes\": \"\",\n \"syncExportDebitNotes\": \"\",\n \"syncExemptReceipts\": \"\",\n \"syncMailCheck\": \"\",\n \"syncMailSend\": \"\",\n \"companyTaxId\": \"\",\n \"senderRut\": \"\",\n \"recipientRut\": \"\",\n \"verificationCode\": \"\",\n \"resolutionDate\": \"\",\n \"resolutionNumber\": \"\",\n \"defaultBranchId\": \"\",\n \"genericProductId\": \"\",\n \"certificateId\": \"\",\n \"certificatePassword\": \"\",\n \"mailHost\": \"\",\n \"mailPassword\": \"\",\n \"mailPort\": \"\",\n \"mailStoreProtocol\": \"\",\n \"mailUser\": \"\",\n \"receiptsCaf\": {},\n \"invoicesCaf\": {},\n \"exemptInvoicesCaf\": {},\n \"deliveryNotesCaf\": {},\n \"creditNotesCaf\": {},\n \"debitNotesCaf\": {},\n \"exemptReceiptsCaf\": {},\n \"purchaseInvoicesCaf\": {},\n \"exportInvoicesCaf\": {},\n \"exportCreditNotesCaf\": {},\n \"exportDebitNotesCaf\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "88ffba7a-fcf6-417d-a560-295993169a9c", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "chile-sii-configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"active\": \"\",\n \"companyId\": \"\",\n \"testMode\": \"\",\n \"autoSync\": \"\",\n \"syncReceipts\": \"\",\n \"syncInvoices\": \"\",\n \"syncExemptInvoices\": \"\",\n \"syncDeliveryNotes\": \"\",\n \"syncInternalDeliveryNotes\": \"\",\n \"syncCreditNotes\": \"\",\n \"syncDebitNotes\": \"\",\n \"syncPurchaseInvoices\": \"\",\n \"syncExportInvoices\": \"\",\n \"syncExportCreditNotes\": \"\",\n \"syncExportDebitNotes\": \"\",\n \"syncExemptReceipts\": \"\",\n \"syncMailCheck\": \"\",\n \"syncMailSend\": \"\",\n \"companyTaxId\": \"\",\n \"senderRut\": \"\",\n \"recipientRut\": \"\",\n \"verificationCode\": \"\",\n \"resolutionDate\": \"\",\n \"resolutionNumber\": \"\",\n \"defaultBranchId\": \"\",\n \"genericProductId\": \"\",\n \"certificateId\": \"\",\n \"certificatePassword\": \"\",\n \"mailHost\": \"\",\n \"mailPassword\": \"\",\n \"mailPort\": \"\",\n \"mailStoreProtocol\": \"\",\n \"mailUser\": \"\",\n \"receiptsCaf\": {},\n \"invoicesCaf\": {},\n \"exemptInvoicesCaf\": {},\n \"deliveryNotesCaf\": {},\n \"creditNotesCaf\": {},\n \"debitNotesCaf\": {},\n \"exemptReceiptsCaf\": {},\n \"purchaseInvoicesCaf\": {},\n \"exportInvoicesCaf\": {},\n \"exportCreditNotesCaf\": {},\n \"exportDebitNotesCaf\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4a303f08-886e-47dd-8a89-80ff4c91c184", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "chile-sii-configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"active\": \"\",\n \"companyId\": \"\",\n \"testMode\": \"\",\n \"autoSync\": \"\",\n \"syncReceipts\": \"\",\n \"syncInvoices\": \"\",\n \"syncExemptInvoices\": \"\",\n \"syncDeliveryNotes\": \"\",\n \"syncInternalDeliveryNotes\": \"\",\n \"syncCreditNotes\": \"\",\n \"syncDebitNotes\": \"\",\n \"syncPurchaseInvoices\": \"\",\n \"syncExportInvoices\": \"\",\n \"syncExportCreditNotes\": \"\",\n \"syncExportDebitNotes\": \"\",\n \"syncExemptReceipts\": \"\",\n \"syncMailCheck\": \"\",\n \"syncMailSend\": \"\",\n \"companyTaxId\": \"\",\n \"senderRut\": \"\",\n \"recipientRut\": \"\",\n \"verificationCode\": \"\",\n \"resolutionDate\": \"\",\n \"resolutionNumber\": \"\",\n \"defaultBranchId\": \"\",\n \"genericProductId\": \"\",\n \"certificateId\": \"\",\n \"certificatePassword\": \"\",\n \"mailHost\": \"\",\n \"mailPassword\": \"\",\n \"mailPort\": \"\",\n \"mailStoreProtocol\": \"\",\n \"mailUser\": \"\",\n \"receiptsCaf\": {},\n \"invoicesCaf\": {},\n \"exemptInvoicesCaf\": {},\n \"deliveryNotesCaf\": {},\n \"creditNotesCaf\": {},\n \"debitNotesCaf\": {},\n \"exemptReceiptsCaf\": {},\n \"purchaseInvoicesCaf\": {},\n \"exportInvoicesCaf\": {},\n \"exportCreditNotesCaf\": {},\n \"exportDebitNotesCaf\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "new", "description": "", "item": [ { "id": "8c03b2f2-0bd1-4271-a805-b3058788585f", "name": "Prototype a Chile SII configuration", "request": { "name": "Prototype a Chile SII configuration", "description": { "content": "Returns form defaults and does not persist a configuration.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "companies", ":companyId", "chile-sii-configuration", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "companyId", "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "56d13c46-d709-438f-a414-b998b5a5f3ea", "name": "Non-persistent prototype", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "chile-sii-configuration", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"active\": \"\",\n \"companyId\": \"\",\n \"testMode\": \"\",\n \"autoSync\": \"\",\n \"syncReceipts\": \"\",\n \"syncInvoices\": \"\",\n \"syncExemptInvoices\": \"\",\n \"syncDeliveryNotes\": \"\",\n \"syncInternalDeliveryNotes\": \"\",\n \"syncCreditNotes\": \"\",\n \"syncDebitNotes\": \"\",\n \"syncPurchaseInvoices\": \"\",\n \"syncExportInvoices\": \"\",\n \"syncExportCreditNotes\": \"\",\n \"syncExportDebitNotes\": \"\",\n \"syncExemptReceipts\": \"\",\n \"syncMailCheck\": \"\",\n \"syncMailSend\": \"\",\n \"companyTaxId\": \"\",\n \"senderRut\": \"\",\n \"recipientRut\": \"\",\n \"verificationCode\": \"\",\n \"resolutionDate\": \"\",\n \"resolutionNumber\": \"\",\n \"defaultBranchId\": \"\",\n \"genericProductId\": \"\",\n \"certificateId\": \"\",\n \"certificateName\": \"\",\n \"certificateFingerprint\": \"\",\n \"certificateExpiresAt\": \"\",\n \"certificateUploadedAt\": \"\",\n \"certificateTaxIdWarning\": \"\",\n \"mailHost\": \"\",\n \"mailPort\": \"\",\n \"mailStoreProtocol\": \"\",\n \"mailUser\": \"\",\n \"receiptsCaf\": {\n \"fileName\": \"\",\n \"folioStart\": \"\",\n \"folioEnd\": \"\",\n \"validUntil\": \"\"\n },\n \"invoicesCaf\": {\n \"fileName\": \"\",\n \"folioStart\": \"\",\n \"folioEnd\": \"\",\n \"validUntil\": \"\"\n },\n \"exemptInvoicesCaf\": {\n \"fileName\": \"\",\n \"folioStart\": \"\",\n \"folioEnd\": \"\",\n \"validUntil\": \"\"\n },\n \"deliveryNotesCaf\": {\n \"fileName\": \"\",\n \"folioStart\": \"\",\n \"folioEnd\": \"\",\n \"validUntil\": \"\"\n },\n \"creditNotesCaf\": {\n \"fileName\": \"\",\n \"folioStart\": \"\",\n \"folioEnd\": \"\",\n \"validUntil\": \"\"\n },\n \"debitNotesCaf\": {\n \"fileName\": \"\",\n \"folioStart\": \"\",\n \"folioEnd\": \"\",\n \"validUntil\": \"\"\n },\n \"exemptReceiptsCaf\": {\n \"fileName\": \"\",\n \"folioStart\": \"\",\n \"folioEnd\": \"\",\n \"validUntil\": \"\"\n },\n \"purchaseInvoicesCaf\": {\n \"fileName\": \"\",\n \"folioStart\": \"\",\n \"folioEnd\": \"\",\n \"validUntil\": \"\"\n },\n \"exportInvoicesCaf\": {\n \"fileName\": \"\",\n \"folioStart\": \"\",\n \"folioEnd\": \"\",\n \"validUntil\": \"\"\n },\n \"exportCreditNotesCaf\": {\n \"fileName\": \"\",\n \"folioStart\": \"\",\n \"folioEnd\": \"\",\n \"validUntil\": \"\"\n },\n \"exportDebitNotesCaf\": {\n \"fileName\": \"\",\n \"folioStart\": \"\",\n \"folioEnd\": \"\",\n \"validUntil\": \"\"\n },\n \"version\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "207065f4-a7a6-46f6-9542-b09af789f1f7", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "chile-sii-configuration", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ead9f44e-b3e8-42ed-ad12-fa9cfc6c00c9", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "chile-sii-configuration", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ab87d92f-3377-4e14-b4b0-483bdaadf6d6", "name": "Missing EDITAR_CONFIGURACIONSIICHILE permission", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "chile-sii-configuration", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1d605e24-d8c2-432f-bea2-ac9f48c7cc96", "name": "Company is outside the authenticated scope", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "chile-sii-configuration", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "afc7fc5a-3f1a-4981-8982-2e90035a4708", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "chile-sii-configuration", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "certificate", "description": "", "item": [ { "id": "023f0b8f-5d71-4833-a0ed-075aab711d02", "name": "Upload and validate the company PKCS#12 certificate", "request": { "name": "Upload and validate the company PKCS#12 certificate", "description": { "content": "Stages a .p12/.pfx certificate and returns an opaque certificateId. The active configuration changes only after a successful PUT.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "companies", ":companyId", "chile-sii-configuration", "certificate" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) PKCS#12 password", "type": "text/plain" }, "key": "password", "value": "" }, { "disabled": false, "description": { "content": "Replace an already staged certificate", "type": "text/plain" }, "key": "replace", "value": "true" } ], "variable": [ { "type": "any", "value": "", "key": "companyId", "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) PKCS#12 certificate (.p12 or .pfx)", "type": "text/plain" }, "key": "file", "type": "file" } ] }, "auth": null }, "response": [ { "id": "32720ad7-a4a5-4ac5-9c60-9c8a0be87cb9", "name": "Certificate validated and staged", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "chile-sii-configuration", "certificate" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) PKCS#12 password", "type": "text/plain" }, "key": "password", "value": "" }, { "disabled": false, "description": { "content": "Replace an already staged certificate", "type": "text/plain" }, "key": "replace", "value": "true" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) PKCS#12 certificate (.p12 or .pfx)", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"certificateId\": \"\",\n \"certificateName\": \"\",\n \"certificateFingerprint\": \"\",\n \"certificateExpiresAt\": \"\",\n \"certificateUploadedAt\": \"\",\n \"certificateTaxIdWarning\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "92b76786-24a0-4156-ba1b-cec836b8ee5a", "name": "Missing file, invalid PKCS#12 or wrong password", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "chile-sii-configuration", "certificate" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) PKCS#12 password", "type": "text/plain" }, "key": "password", "value": "" }, { "disabled": false, "description": { "content": "Replace an already staged certificate", "type": "text/plain" }, "key": "replace", "value": "true" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) PKCS#12 certificate (.p12 or .pfx)", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6f1b5035-f0c4-4004-93c8-4bccd73a5db8", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "chile-sii-configuration", "certificate" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) PKCS#12 password", "type": "text/plain" }, "key": "password", "value": "" }, { "disabled": false, "description": { "content": "Replace an already staged certificate", "type": "text/plain" }, "key": "replace", "value": "true" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) PKCS#12 certificate (.p12 or .pfx)", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c0468fe3-4f60-4feb-9c1f-92b9b9968b1a", "name": "Missing EDITAR_CONFIGURACIONSIICHILE permission", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "chile-sii-configuration", "certificate" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) PKCS#12 password", "type": "text/plain" }, "key": "password", "value": "" }, { "disabled": false, "description": { "content": "Replace an already staged certificate", "type": "text/plain" }, "key": "replace", "value": "true" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) PKCS#12 certificate (.p12 or .pfx)", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ea19527a-bee4-475f-a687-89171a07a167", "name": "Company is outside the authenticated scope", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "chile-sii-configuration", "certificate" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) PKCS#12 password", "type": "text/plain" }, "key": "password", "value": "" }, { "disabled": false, "description": { "content": "Replace an already staged certificate", "type": "text/plain" }, "key": "replace", "value": "true" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) PKCS#12 certificate (.p12 or .pfx)", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a39ec56f-fb6e-4bae-93af-e4d7fd5ecd3c", "name": "Certificate exceeds 5 MB", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "chile-sii-configuration", "certificate" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) PKCS#12 password", "type": "text/plain" }, "key": "password", "value": "" }, { "disabled": false, "description": { "content": "Replace an already staged certificate", "type": "text/plain" }, "key": "replace", "value": "true" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) PKCS#12 certificate (.p12 or .pfx)", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "958ed628-f646-4899-a835-5c76a8d356d1", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "chile-sii-configuration", "certificate" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) PKCS#12 password", "type": "text/plain" }, "key": "password", "value": "" }, { "disabled": false, "description": { "content": "Replace an already staged certificate", "type": "text/plain" }, "key": "replace", "value": "true" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) PKCS#12 certificate (.p12 or .pfx)", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "caf", "description": "", "item": [ { "id": "98478f01-e702-407d-a1f3-12d230a4a1f9", "name": "Upload and validate a CAF file", "request": { "name": "Upload and validate a CAF file", "description": { "content": "Validates the CAF XML for the requested document type and persists it using the same business rules as the legacy JSF screen.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "companies", ":companyId", "chile-sii-configuration", "caf" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) CAF document type", "type": "text/plain" }, "key": "documentType", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "companyId", "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) CAF XML file", "type": "text/plain" }, "key": "file", "type": "file" } ] }, "auth": null }, "response": [ { "id": "4de9bbb9-2269-4bdd-be08-35aeb0c59de0", "name": "CAF validated and persisted", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "chile-sii-configuration", "caf" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) CAF document type", "type": "text/plain" }, "key": "documentType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) CAF XML file", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"documentType\": \"EXPORT_CREDIT_NOTES\",\n \"fileName\": \"\",\n \"folioStart\": \"\",\n \"folioEnd\": \"\",\n \"validUntil\": \"\",\n \"version\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b57a1719-0383-4398-9850-23a5e89603a7", "name": "Invalid CAF file or document type", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "chile-sii-configuration", "caf" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) CAF document type", "type": "text/plain" }, "key": "documentType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) CAF XML file", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5f548d12-a9c7-4412-b19b-0dedf07ffff7", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "chile-sii-configuration", "caf" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) CAF document type", "type": "text/plain" }, "key": "documentType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) CAF XML file", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "74c5477a-5d29-4fd3-b1ed-4d6ae48cbf83", "name": "Missing EDITAR_CONFIGURACIONSIICHILE permission", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "chile-sii-configuration", "caf" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) CAF document type", "type": "text/plain" }, "key": "documentType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) CAF XML file", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "dc2102ab-aef7-41b7-861c-cfd36eb3ce4a", "name": "Company is outside scope or configuration missing", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "chile-sii-configuration", "caf" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) CAF document type", "type": "text/plain" }, "key": "documentType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) CAF XML file", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b8fd830b-3f7a-4791-bdd1-34dece376526", "name": "CAF exceeds 2 MB", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "chile-sii-configuration", "caf" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) CAF document type", "type": "text/plain" }, "key": "documentType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) CAF XML file", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b57f881f-1b43-4647-aa83-ff2a07adbb91", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "companies", ":companyId", "chile-sii-configuration", "caf" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) CAF document type", "type": "text/plain" }, "key": "documentType", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Company ID", "type": "text/plain" }, "type": "any", "value": "", "key": "companyId" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) CAF XML file", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] } ] }, { "name": "collections", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "53aa4804-5361-4214-9bed-ba129f75effb", "name": "Get collection by ID", "request": { "name": "Get collection by ID", "description": { "content": "Returns a single collection by its primary key. The response carries a strong `ETag` header with the current version.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "collections", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Collection ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "c76b70f5-5502-4d73-aeed-1f6fa8bfc2b3", "name": "Collection found", "originalRequest": { "url": { "path": [ "api", "v2", "collections", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Collection ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "35d3f87c-072a-45dd-a45e-746fd5ec1911", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "collections", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Collection ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "79753ba1-7c3c-4d8c-8546-6535d8b45f91", "name": "Authenticated user is missing the `VER_LINEAS_PRODUCTO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "collections", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Collection ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e7f0304d-ad97-4129-a912-a6384606931a", "name": "Collection not found", "originalRequest": { "url": { "path": [ "api", "v2", "collections", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Collection ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "28ec7d86-74ed-41f0-904b-ec1b98754889", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "collections", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Collection ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1a41c43b-e3aa-4e37-853e-120bc66f15e2", "name": "Update collection", "request": { "name": "Update collection", "description": { "content": "Full replacement of an existing collection. Send the `If-Match` header with the current ETag for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "collections", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Collection ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "ce1afa01-791f-46d7-8674-11670f58d12e", "name": "Collection updated", "originalRequest": { "url": { "path": [ "api", "v2", "collections", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Collection ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "42ddc62a-e12c-4b4f-b2f8-540186ebd15a", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "collections", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Collection ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0073045d-1038-471b-a88e-4d437064b63c", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "collections", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Collection ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "af3a59ba-ed26-4f49-8d08-af4223f93313", "name": "Authenticated user is missing the `EDITAR_LINEAS_PRODUCTO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "collections", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Collection ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c05dd610-ac72-4778-bba9-e67ba9f9faed", "name": "Collection not found", "originalRequest": { "url": { "path": [ "api", "v2", "collections", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Collection ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c04ed67a-ded2-4925-92b9-2fc6798f3327", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "collections", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Collection ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "121f809e-ab89-40cf-baab-d96244251758", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "collections", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Collection ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "15232212-01f3-4e08-a6ac-fa782e6d23a4", "name": "Delete collection", "request": { "name": "Delete collection", "description": { "content": "Deletes a collection. Send the `If-Match` header with the current ETag for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "collections", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Collection ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "26785d98-fec4-43cf-8d56-1111abf8c542", "name": "Collection deleted", "originalRequest": { "url": { "path": [ "api", "v2", "collections", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Collection ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ca5db41f-179d-4d23-950d-f869c6ac83fb", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "collections", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Collection ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3d441719-e326-4f3a-b7cc-47addd9f6c76", "name": "Authenticated user is missing the `BORRAR_LINEAS_PRODUCTO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "collections", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Collection ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1db4f1b2-5412-48c9-90fa-c067e6756356", "name": "Collection not found", "originalRequest": { "url": { "path": [ "api", "v2", "collections", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Collection ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5456000d-b7dd-48b0-8577-f42b3dd29107", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "collections", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Collection ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9c3e9d4a-e834-429c-ba2c-4a21cc2e04a0", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "collections", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Collection ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "701df576-feb7-45b4-baea-eac1070db25b", "name": "Merge-patch collection", "request": { "name": "Merge-patch collection", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "collections", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Collection ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "c33a0983-516f-404d-bd4b-17b5bb120151", "name": "Collection patched", "originalRequest": { "url": { "path": [ "api", "v2", "collections", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Collection ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c4dda1bc-7288-4ea9-b531-fa05114b78d6", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details. Also returned for malformed merge-patch payloads.", "originalRequest": { "url": { "path": [ "api", "v2", "collections", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Collection ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "71ae815c-86de-4f74-b568-36c5a478ae9d", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "collections", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Collection ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "faa41215-f07e-4243-9f15-0c05c552944b", "name": "Authenticated user is missing the `EDITAR_LINEAS_PRODUCTO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "collections", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Collection ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d3897d8e-3d28-4796-90de-29a7915a6880", "name": "Collection not found", "originalRequest": { "url": { "path": [ "api", "v2", "collections", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Collection ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "186b3289-e0b5-489d-bcf2-25208a8aa544", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "collections", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Collection ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b6a7a13d-f25a-4740-bf3f-3a931a5a0a38", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "collections", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Collection ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "52113ddd-7d0a-499c-9ecc-b15f6f0f3af4", "name": "List collections", "request": { "name": "List collections", "description": { "content": "Returns a paginated list of collections with envelope `{data, totalCount, skip, limit, hasMore}`. Default sort is `name:asc`. Limit is capped at 200; skip is clamped to >= 0.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "collections" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "a7ad47ba-7ed9-4f9f-829c-4afc87dd4e18", "name": "Page of collections", "originalRequest": { "url": { "path": [ "api", "v2", "collections" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "07e68d24-f78d-49f1-b92e-0f9f832212d7", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "collections" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1d10aa16-f0fa-42e0-8f1a-268ab8e07575", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "collections" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3a193977-8565-4a8f-8d65-85e1aeaa5f25", "name": "Authenticated user is missing the `VER_LINEAS_PRODUCTO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "collections" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bf0c7c30-8079-431b-9913-b0ccc974fa65", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "collections" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f90a7405-6d10-4e31-b2a9-4c33455b315d", "name": "Create collection", "request": { "name": "Create collection", "description": { "content": "Creates a new collection. Business logic runs in the legacy WAR via the internal commands gateway.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "collections" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "17615635-00e7-41b5-a815-e0ef7d4446d8", "name": "Collection created", "originalRequest": { "url": { "path": [ "api", "v2", "collections" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "965bc0f5-e69a-4925-b431-ba5007fa8883", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "collections" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4451631b-f644-4211-a114-f635d311ba6f", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "collections" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6c61b10e-9560-482d-972d-37b82d5d641b", "name": "Authenticated user is missing the `CREAR_LINEAS_PRODUCTO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "collections" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a03626c7-6c99-435b-bbe1-588ec043ecb0", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "collections" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "new", "description": "", "item": [ { "id": "b99b417e-7a62-488f-a177-45e7fd2ea8be", "name": "Prototype collection for a creation form", "request": { "name": "Prototype collection for a creation form", "description": { "content": "Returns a non-persisted collection pre-populated with backend defaults. Optional hints include `companyId` and `copyFromId`. The response has no `id`, `version` or audit fields; call `POST /api/v2/collections` afterwards to persist it.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "collections", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "ff787715-6ed7-45f1-a741-bc7d4e51d3c2", "name": "Collection prototype with defaults", "originalRequest": { "url": { "path": [ "api", "v2", "collections", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "89cfb5c1-785b-47df-9bab-6b27dab32fc1", "name": "Invalid prepare-create hints", "originalRequest": { "url": { "path": [ "api", "v2", "collections", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2f34458b-2e0e-486e-9085-ce2d801d436a", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "collections", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2cb5ace7-e8fe-47d8-b9ad-5e661fed1ed4", "name": "Authenticated user is missing the `CREAR_LINEAS_PRODUCTO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "collections", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d67fcb0f-87d0-438a-821f-f8cc3038b915", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "collections", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "claim-types", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "5c12de68-e45d-4599-91f5-cef61e7fe89c", "name": "Get claim type by ID", "request": { "name": "Get claim type by ID", "description": { "content": "Returns a single claim type by its primary key, including configured solutions.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "claim-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Claim type ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "aef39255-d225-430a-b33d-9d8633cef224", "name": "Claim type found", "originalRequest": { "url": { "path": [ "api", "v2", "claim-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Claim type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"durationDays\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"solutions\": [\n {\n \"id\": \"\",\n \"version\": \"\",\n \"claimTypeId\": \"\",\n \"claimTypeName\": \"\",\n \"solutionTypeId\": \"\",\n \"solutionTypeName\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"employeeLevel\": \"\",\n \"allowsLensChange\": \"\",\n \"allowsRefund\": \"\",\n \"allowsPin\": \"\",\n \"allowsCreditNote\": \"\",\n \"allowsWarranty\": \"\",\n \"allowsOrder\": \"\",\n \"allowsOrderEdit\": \"\",\n \"orderTypeId\": \"\",\n \"orderTypeName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n },\n {\n \"id\": \"\",\n \"version\": \"\",\n \"claimTypeId\": \"\",\n \"claimTypeName\": \"\",\n \"solutionTypeId\": \"\",\n \"solutionTypeName\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"employeeLevel\": \"\",\n \"allowsLensChange\": \"\",\n \"allowsRefund\": \"\",\n \"allowsPin\": \"\",\n \"allowsCreditNote\": \"\",\n \"allowsWarranty\": \"\",\n \"allowsOrder\": \"\",\n \"allowsOrderEdit\": \"\",\n \"orderTypeId\": \"\",\n \"orderTypeName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9401071e-9677-47ab-9463-20bdc883347d", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "claim-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Claim type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c27e7ebb-becd-4db4-9bd7-088765f82a97", "name": "Authenticated user is missing the `VER_RECLAMOTIPORECLAMO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "claim-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Claim type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5681cd01-ed89-4ec1-b576-e007ff330345", "name": "Claim type not found", "originalRequest": { "url": { "path": [ "api", "v2", "claim-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Claim type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9294192e-b750-46b2-8a5c-691442e7619e", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "claim-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Claim type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1873b2f8-c241-42cf-8105-d8d8abda8258", "name": "Update claim type", "request": { "name": "Update claim type", "description": { "content": "Full replacement of an existing claim type and its configured solutions. Send the `If-Match` header for optimistic concurrency (accepted but ignored ÔÇö not versioned).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "claim-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Claim type ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"durationDays\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"solutions\": [\n {\n \"solutionTypeId\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"employeeLevel\": \"\",\n \"allowsLensChange\": \"\",\n \"allowsRefund\": \"\",\n \"allowsPin\": \"\",\n \"allowsCreditNote\": \"\",\n \"allowsWarranty\": \"\",\n \"allowsOrder\": \"\",\n \"allowsOrderEdit\": \"\",\n \"orderTypeId\": \"\"\n },\n {\n \"solutionTypeId\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"employeeLevel\": \"\",\n \"allowsLensChange\": \"\",\n \"allowsRefund\": \"\",\n \"allowsPin\": \"\",\n \"allowsCreditNote\": \"\",\n \"allowsWarranty\": \"\",\n \"allowsOrder\": \"\",\n \"allowsOrderEdit\": \"\",\n \"orderTypeId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "45368bf3-398f-46bd-9299-66c47f5b57f7", "name": "Claim type updated", "originalRequest": { "url": { "path": [ "api", "v2", "claim-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Claim type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"durationDays\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"solutions\": [\n {\n \"solutionTypeId\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"employeeLevel\": \"\",\n \"allowsLensChange\": \"\",\n \"allowsRefund\": \"\",\n \"allowsPin\": \"\",\n \"allowsCreditNote\": \"\",\n \"allowsWarranty\": \"\",\n \"allowsOrder\": \"\",\n \"allowsOrderEdit\": \"\",\n \"orderTypeId\": \"\"\n },\n {\n \"solutionTypeId\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"employeeLevel\": \"\",\n \"allowsLensChange\": \"\",\n \"allowsRefund\": \"\",\n \"allowsPin\": \"\",\n \"allowsCreditNote\": \"\",\n \"allowsWarranty\": \"\",\n \"allowsOrder\": \"\",\n \"allowsOrderEdit\": \"\",\n \"orderTypeId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"durationDays\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"solutions\": [\n {\n \"id\": \"\",\n \"version\": \"\",\n \"claimTypeId\": \"\",\n \"claimTypeName\": \"\",\n \"solutionTypeId\": \"\",\n \"solutionTypeName\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"employeeLevel\": \"\",\n \"allowsLensChange\": \"\",\n \"allowsRefund\": \"\",\n \"allowsPin\": \"\",\n \"allowsCreditNote\": \"\",\n \"allowsWarranty\": \"\",\n \"allowsOrder\": \"\",\n \"allowsOrderEdit\": \"\",\n \"orderTypeId\": \"\",\n \"orderTypeName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n },\n {\n \"id\": \"\",\n \"version\": \"\",\n \"claimTypeId\": \"\",\n \"claimTypeName\": \"\",\n \"solutionTypeId\": \"\",\n \"solutionTypeName\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"employeeLevel\": \"\",\n \"allowsLensChange\": \"\",\n \"allowsRefund\": \"\",\n \"allowsPin\": \"\",\n \"allowsCreditNote\": \"\",\n \"allowsWarranty\": \"\",\n \"allowsOrder\": \"\",\n \"allowsOrderEdit\": \"\",\n \"orderTypeId\": \"\",\n \"orderTypeName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ff3420b4-6ce9-4ae1-99b8-e4c8cd6eaa6a", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "claim-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Claim type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"durationDays\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"solutions\": [\n {\n \"solutionTypeId\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"employeeLevel\": \"\",\n \"allowsLensChange\": \"\",\n \"allowsRefund\": \"\",\n \"allowsPin\": \"\",\n \"allowsCreditNote\": \"\",\n \"allowsWarranty\": \"\",\n \"allowsOrder\": \"\",\n \"allowsOrderEdit\": \"\",\n \"orderTypeId\": \"\"\n },\n {\n \"solutionTypeId\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"employeeLevel\": \"\",\n \"allowsLensChange\": \"\",\n \"allowsRefund\": \"\",\n \"allowsPin\": \"\",\n \"allowsCreditNote\": \"\",\n \"allowsWarranty\": \"\",\n \"allowsOrder\": \"\",\n \"allowsOrderEdit\": \"\",\n \"orderTypeId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1051c6e0-d857-4316-aa85-39bc6bd2e3fb", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "claim-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Claim type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"durationDays\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"solutions\": [\n {\n \"solutionTypeId\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"employeeLevel\": \"\",\n \"allowsLensChange\": \"\",\n \"allowsRefund\": \"\",\n \"allowsPin\": \"\",\n \"allowsCreditNote\": \"\",\n \"allowsWarranty\": \"\",\n \"allowsOrder\": \"\",\n \"allowsOrderEdit\": \"\",\n \"orderTypeId\": \"\"\n },\n {\n \"solutionTypeId\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"employeeLevel\": \"\",\n \"allowsLensChange\": \"\",\n \"allowsRefund\": \"\",\n \"allowsPin\": \"\",\n \"allowsCreditNote\": \"\",\n \"allowsWarranty\": \"\",\n \"allowsOrder\": \"\",\n \"allowsOrderEdit\": \"\",\n \"orderTypeId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "471b983d-27ea-408a-a853-d5f7284fdbd6", "name": "Authenticated user is missing the `EDITAR_RECLAMOTIPORECLAMO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "claim-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Claim type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"durationDays\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"solutions\": [\n {\n \"solutionTypeId\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"employeeLevel\": \"\",\n \"allowsLensChange\": \"\",\n \"allowsRefund\": \"\",\n \"allowsPin\": \"\",\n \"allowsCreditNote\": \"\",\n \"allowsWarranty\": \"\",\n \"allowsOrder\": \"\",\n \"allowsOrderEdit\": \"\",\n \"orderTypeId\": \"\"\n },\n {\n \"solutionTypeId\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"employeeLevel\": \"\",\n \"allowsLensChange\": \"\",\n \"allowsRefund\": \"\",\n \"allowsPin\": \"\",\n \"allowsCreditNote\": \"\",\n \"allowsWarranty\": \"\",\n \"allowsOrder\": \"\",\n \"allowsOrderEdit\": \"\",\n \"orderTypeId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6dda888d-4b07-448e-9ab6-5b045b9926ed", "name": "Claim type not found", "originalRequest": { "url": { "path": [ "api", "v2", "claim-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Claim type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"durationDays\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"solutions\": [\n {\n \"solutionTypeId\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"employeeLevel\": \"\",\n \"allowsLensChange\": \"\",\n \"allowsRefund\": \"\",\n \"allowsPin\": \"\",\n \"allowsCreditNote\": \"\",\n \"allowsWarranty\": \"\",\n \"allowsOrder\": \"\",\n \"allowsOrderEdit\": \"\",\n \"orderTypeId\": \"\"\n },\n {\n \"solutionTypeId\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"employeeLevel\": \"\",\n \"allowsLensChange\": \"\",\n \"allowsRefund\": \"\",\n \"allowsPin\": \"\",\n \"allowsCreditNote\": \"\",\n \"allowsWarranty\": \"\",\n \"allowsOrder\": \"\",\n \"allowsOrderEdit\": \"\",\n \"orderTypeId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9895b5e5-2440-425b-bdb5-9f013354abe8", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "claim-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Claim type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"durationDays\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"solutions\": [\n {\n \"solutionTypeId\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"employeeLevel\": \"\",\n \"allowsLensChange\": \"\",\n \"allowsRefund\": \"\",\n \"allowsPin\": \"\",\n \"allowsCreditNote\": \"\",\n \"allowsWarranty\": \"\",\n \"allowsOrder\": \"\",\n \"allowsOrderEdit\": \"\",\n \"orderTypeId\": \"\"\n },\n {\n \"solutionTypeId\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"employeeLevel\": \"\",\n \"allowsLensChange\": \"\",\n \"allowsRefund\": \"\",\n \"allowsPin\": \"\",\n \"allowsCreditNote\": \"\",\n \"allowsWarranty\": \"\",\n \"allowsOrder\": \"\",\n \"allowsOrderEdit\": \"\",\n \"orderTypeId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "66fa69fc-b27a-4f29-8545-040ed3205b4e", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "claim-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Claim type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"durationDays\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"solutions\": [\n {\n \"solutionTypeId\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"employeeLevel\": \"\",\n \"allowsLensChange\": \"\",\n \"allowsRefund\": \"\",\n \"allowsPin\": \"\",\n \"allowsCreditNote\": \"\",\n \"allowsWarranty\": \"\",\n \"allowsOrder\": \"\",\n \"allowsOrderEdit\": \"\",\n \"orderTypeId\": \"\"\n },\n {\n \"solutionTypeId\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"employeeLevel\": \"\",\n \"allowsLensChange\": \"\",\n \"allowsRefund\": \"\",\n \"allowsPin\": \"\",\n \"allowsCreditNote\": \"\",\n \"allowsWarranty\": \"\",\n \"allowsOrder\": \"\",\n \"allowsOrderEdit\": \"\",\n \"orderTypeId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4c49a0c2-86a0-4f6c-a159-d0480c1dee96", "name": "Delete claim type", "request": { "name": "Delete claim type", "description": { "content": "Deletes a claim type. Send the `If-Match` header with the current ETag (accepted but ignored ÔÇö not versioned).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "claim-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Claim type ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "43b273a0-5594-4253-bf65-61ace95cee20", "name": "Claim type deleted", "originalRequest": { "url": { "path": [ "api", "v2", "claim-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Claim type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5ded80b3-3333-4f31-8889-6fa99ca78464", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "claim-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Claim type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a68ac56e-486b-4c00-a201-ab24526a280c", "name": "Authenticated user is missing the `BORRAR_RECLAMOTIPORECLAMO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "claim-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Claim type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c30f9d52-0606-4a05-a2e2-40bce5f27ddf", "name": "Claim type not found", "originalRequest": { "url": { "path": [ "api", "v2", "claim-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Claim type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6b0427e0-fe65-452a-8a58-6b8657bdbf4f", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "claim-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Claim type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3c76dbf3-72e6-4bfd-93f7-58fa17bcaafe", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "claim-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Claim type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "00dff84c-ee1c-41c5-8ada-188de645645d", "name": "Merge-patch claim type", "request": { "name": "Merge-patch claim type", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "claim-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Claim type ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "3fa0fcf9-f127-430b-ac41-d73f99070500", "name": "Claim type patched", "originalRequest": { "url": { "path": [ "api", "v2", "claim-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Claim type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"durationDays\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"solutions\": [\n {\n \"id\": \"\",\n \"version\": \"\",\n \"claimTypeId\": \"\",\n \"claimTypeName\": \"\",\n \"solutionTypeId\": \"\",\n \"solutionTypeName\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"employeeLevel\": \"\",\n \"allowsLensChange\": \"\",\n \"allowsRefund\": \"\",\n \"allowsPin\": \"\",\n \"allowsCreditNote\": \"\",\n \"allowsWarranty\": \"\",\n \"allowsOrder\": \"\",\n \"allowsOrderEdit\": \"\",\n \"orderTypeId\": \"\",\n \"orderTypeName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n },\n {\n \"id\": \"\",\n \"version\": \"\",\n \"claimTypeId\": \"\",\n \"claimTypeName\": \"\",\n \"solutionTypeId\": \"\",\n \"solutionTypeName\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"employeeLevel\": \"\",\n \"allowsLensChange\": \"\",\n \"allowsRefund\": \"\",\n \"allowsPin\": \"\",\n \"allowsCreditNote\": \"\",\n \"allowsWarranty\": \"\",\n \"allowsOrder\": \"\",\n \"allowsOrderEdit\": \"\",\n \"orderTypeId\": \"\",\n \"orderTypeName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b9107829-8430-44c6-a4fc-4d9eb9bc446a", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details. Also returned for malformed merge-patch payloads.", "originalRequest": { "url": { "path": [ "api", "v2", "claim-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Claim type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "10e528ee-f8e7-4919-a701-796fb03ea3ae", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "claim-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Claim type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8d5c419e-f46d-491e-a16d-926d84de35fd", "name": "Authenticated user is missing the `EDITAR_RECLAMOTIPORECLAMO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "claim-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Claim type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d7c28db9-afd0-4f28-a691-a588d90353bf", "name": "Claim type not found", "originalRequest": { "url": { "path": [ "api", "v2", "claim-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Claim type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e2e7c4cb-9ba3-4b51-9e4e-a968eed43adc", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "claim-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Claim type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1bf6f824-4e8d-4bab-abc4-9e40243515f9", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "claim-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Claim type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "637a8795-b6b6-4de9-a947-85be47bde6ae", "name": "List claim types", "request": { "name": "List claim types", "description": { "content": "Returns a paginated list of claim types with envelope `{data, totalCount, skip, limit, hasMore}`. Supports optional RSQL `filter`, `sort` (default `name:asc`), `skip`/`limit` pagination and `modifiedAfter`/`modifiedBefore` bookends.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "claim-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "21702cc8-92e2-429a-8b0e-3143571dbf55", "name": "Page of claim types", "originalRequest": { "url": { "path": [ "api", "v2", "claim-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6ea158d7-3b65-44a7-86af-d0c30de004f9", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "claim-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cb0615ca-420a-4c81-adc6-fc061a6ec966", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "claim-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fba53c8e-1d03-439c-80cf-71c5b5d7de9e", "name": "Authenticated user is missing the `VER_RECLAMOTIPORECLAMO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "claim-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5e33e25f-8b8e-4996-ae1a-e28aade617b5", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "claim-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c3fc37a5-aa3d-4444-ae02-1fabd3dcf6cc", "name": "Create claim type", "request": { "name": "Create claim type", "description": { "content": "Creates a new claim type and its configured solutions. Business logic runs in the legacy WAR via the internal commands gateway.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "claim-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"durationDays\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"solutions\": [\n {\n \"solutionTypeId\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"employeeLevel\": \"\",\n \"allowsLensChange\": \"\",\n \"allowsRefund\": \"\",\n \"allowsPin\": \"\",\n \"allowsCreditNote\": \"\",\n \"allowsWarranty\": \"\",\n \"allowsOrder\": \"\",\n \"allowsOrderEdit\": \"\",\n \"orderTypeId\": \"\"\n },\n {\n \"solutionTypeId\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"employeeLevel\": \"\",\n \"allowsLensChange\": \"\",\n \"allowsRefund\": \"\",\n \"allowsPin\": \"\",\n \"allowsCreditNote\": \"\",\n \"allowsWarranty\": \"\",\n \"allowsOrder\": \"\",\n \"allowsOrderEdit\": \"\",\n \"orderTypeId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "d6d3bbf1-d916-4254-8f9d-3a37bb50c68e", "name": "Claim type created", "originalRequest": { "url": { "path": [ "api", "v2", "claim-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"durationDays\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"solutions\": [\n {\n \"solutionTypeId\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"employeeLevel\": \"\",\n \"allowsLensChange\": \"\",\n \"allowsRefund\": \"\",\n \"allowsPin\": \"\",\n \"allowsCreditNote\": \"\",\n \"allowsWarranty\": \"\",\n \"allowsOrder\": \"\",\n \"allowsOrderEdit\": \"\",\n \"orderTypeId\": \"\"\n },\n {\n \"solutionTypeId\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"employeeLevel\": \"\",\n \"allowsLensChange\": \"\",\n \"allowsRefund\": \"\",\n \"allowsPin\": \"\",\n \"allowsCreditNote\": \"\",\n \"allowsWarranty\": \"\",\n \"allowsOrder\": \"\",\n \"allowsOrderEdit\": \"\",\n \"orderTypeId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"durationDays\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"solutions\": [\n {\n \"id\": \"\",\n \"version\": \"\",\n \"claimTypeId\": \"\",\n \"claimTypeName\": \"\",\n \"solutionTypeId\": \"\",\n \"solutionTypeName\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"employeeLevel\": \"\",\n \"allowsLensChange\": \"\",\n \"allowsRefund\": \"\",\n \"allowsPin\": \"\",\n \"allowsCreditNote\": \"\",\n \"allowsWarranty\": \"\",\n \"allowsOrder\": \"\",\n \"allowsOrderEdit\": \"\",\n \"orderTypeId\": \"\",\n \"orderTypeName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n },\n {\n \"id\": \"\",\n \"version\": \"\",\n \"claimTypeId\": \"\",\n \"claimTypeName\": \"\",\n \"solutionTypeId\": \"\",\n \"solutionTypeName\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"employeeLevel\": \"\",\n \"allowsLensChange\": \"\",\n \"allowsRefund\": \"\",\n \"allowsPin\": \"\",\n \"allowsCreditNote\": \"\",\n \"allowsWarranty\": \"\",\n \"allowsOrder\": \"\",\n \"allowsOrderEdit\": \"\",\n \"orderTypeId\": \"\",\n \"orderTypeName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0b9da4db-862f-4f01-bc13-99ec85f50230", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "claim-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"durationDays\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"solutions\": [\n {\n \"solutionTypeId\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"employeeLevel\": \"\",\n \"allowsLensChange\": \"\",\n \"allowsRefund\": \"\",\n \"allowsPin\": \"\",\n \"allowsCreditNote\": \"\",\n \"allowsWarranty\": \"\",\n \"allowsOrder\": \"\",\n \"allowsOrderEdit\": \"\",\n \"orderTypeId\": \"\"\n },\n {\n \"solutionTypeId\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"employeeLevel\": \"\",\n \"allowsLensChange\": \"\",\n \"allowsRefund\": \"\",\n \"allowsPin\": \"\",\n \"allowsCreditNote\": \"\",\n \"allowsWarranty\": \"\",\n \"allowsOrder\": \"\",\n \"allowsOrderEdit\": \"\",\n \"orderTypeId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "88e6241b-fdda-4248-9d31-c7dd68ac0024", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "claim-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"durationDays\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"solutions\": [\n {\n \"solutionTypeId\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"employeeLevel\": \"\",\n \"allowsLensChange\": \"\",\n \"allowsRefund\": \"\",\n \"allowsPin\": \"\",\n \"allowsCreditNote\": \"\",\n \"allowsWarranty\": \"\",\n \"allowsOrder\": \"\",\n \"allowsOrderEdit\": \"\",\n \"orderTypeId\": \"\"\n },\n {\n \"solutionTypeId\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"employeeLevel\": \"\",\n \"allowsLensChange\": \"\",\n \"allowsRefund\": \"\",\n \"allowsPin\": \"\",\n \"allowsCreditNote\": \"\",\n \"allowsWarranty\": \"\",\n \"allowsOrder\": \"\",\n \"allowsOrderEdit\": \"\",\n \"orderTypeId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9a1664ee-badf-41d4-8dbf-9180681c60e7", "name": "Authenticated user is missing the `CREAR_RECLAMOTIPORECLAMO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "claim-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"durationDays\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"solutions\": [\n {\n \"solutionTypeId\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"employeeLevel\": \"\",\n \"allowsLensChange\": \"\",\n \"allowsRefund\": \"\",\n \"allowsPin\": \"\",\n \"allowsCreditNote\": \"\",\n \"allowsWarranty\": \"\",\n \"allowsOrder\": \"\",\n \"allowsOrderEdit\": \"\",\n \"orderTypeId\": \"\"\n },\n {\n \"solutionTypeId\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"employeeLevel\": \"\",\n \"allowsLensChange\": \"\",\n \"allowsRefund\": \"\",\n \"allowsPin\": \"\",\n \"allowsCreditNote\": \"\",\n \"allowsWarranty\": \"\",\n \"allowsOrder\": \"\",\n \"allowsOrderEdit\": \"\",\n \"orderTypeId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6d1508dd-f244-4ce7-aa3e-ab98bf22b3ed", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "claim-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"durationDays\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"solutions\": [\n {\n \"solutionTypeId\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"employeeLevel\": \"\",\n \"allowsLensChange\": \"\",\n \"allowsRefund\": \"\",\n \"allowsPin\": \"\",\n \"allowsCreditNote\": \"\",\n \"allowsWarranty\": \"\",\n \"allowsOrder\": \"\",\n \"allowsOrderEdit\": \"\",\n \"orderTypeId\": \"\"\n },\n {\n \"solutionTypeId\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"employeeLevel\": \"\",\n \"allowsLensChange\": \"\",\n \"allowsRefund\": \"\",\n \"allowsPin\": \"\",\n \"allowsCreditNote\": \"\",\n \"allowsWarranty\": \"\",\n \"allowsOrder\": \"\",\n \"allowsOrderEdit\": \"\",\n \"orderTypeId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "new", "description": "", "item": [ { "id": "cba44f67-a362-449a-b322-33efd3aa9932", "name": "Prototype claim type for a creation form", "request": { "name": "Prototype claim type for a creation form", "description": { "content": "Returns a non-persisted claim type pre-populated with backend defaults (`enabled=true`, current company). Optional JSON hints: `companyId`, `copyFromId`. The response has no `id`, `version` or audit fields; call `POST /api/v2/claim-types` afterwards to persist.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "claim-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "6967464a-5db9-4891-a615-0f1a46c3980b", "name": "Claim type prototype with defaults", "originalRequest": { "url": { "path": [ "api", "v2", "claim-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"durationDays\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"solutions\": [\n {\n \"id\": \"\",\n \"version\": \"\",\n \"claimTypeId\": \"\",\n \"claimTypeName\": \"\",\n \"solutionTypeId\": \"\",\n \"solutionTypeName\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"employeeLevel\": \"\",\n \"allowsLensChange\": \"\",\n \"allowsRefund\": \"\",\n \"allowsPin\": \"\",\n \"allowsCreditNote\": \"\",\n \"allowsWarranty\": \"\",\n \"allowsOrder\": \"\",\n \"allowsOrderEdit\": \"\",\n \"orderTypeId\": \"\",\n \"orderTypeName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n },\n {\n \"id\": \"\",\n \"version\": \"\",\n \"claimTypeId\": \"\",\n \"claimTypeName\": \"\",\n \"solutionTypeId\": \"\",\n \"solutionTypeName\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"employeeLevel\": \"\",\n \"allowsLensChange\": \"\",\n \"allowsRefund\": \"\",\n \"allowsPin\": \"\",\n \"allowsCreditNote\": \"\",\n \"allowsWarranty\": \"\",\n \"allowsOrder\": \"\",\n \"allowsOrderEdit\": \"\",\n \"orderTypeId\": \"\",\n \"orderTypeName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6c03048e-22ec-4fd0-add3-084eddd01318", "name": "Invalid prepare-create hints", "originalRequest": { "url": { "path": [ "api", "v2", "claim-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8d1687e2-b2b9-43e2-bc3a-16a8b43ff10c", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "claim-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b73df250-ff40-48cf-8726-05d856212824", "name": "Authenticated user is missing the `CREAR_RECLAMOTIPORECLAMO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "claim-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "dcdca66d-a7f7-4c55-a6da-b264ff9877c9", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "claim-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "claim-causes", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "eb8ced8e-955c-43d3-8413-bf0b9568d396", "name": "Get claim cause by ID", "request": { "name": "Get claim cause by ID", "description": { "content": "Returns a single claim cause by its primary key.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "claim-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Claim cause ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "774136d7-aa4d-4b8c-93d0-78038bad51a0", "name": "Claim cause found", "originalRequest": { "url": { "path": [ "api", "v2", "claim-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Claim cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e6c7c04c-de69-42b2-913c-fafc2aedd604", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "claim-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Claim cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2fd0856c-6823-4c5a-95b6-3faf2f1cf056", "name": "Authenticated user is missing the `VER_RECLAMOCAUSANTE` permission", "originalRequest": { "url": { "path": [ "api", "v2", "claim-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Claim cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "55d2ed2d-40a4-4bf5-9749-ef0092ab8434", "name": "Claim cause not found", "originalRequest": { "url": { "path": [ "api", "v2", "claim-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Claim cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "01366c5d-9758-4a0e-b69e-5ccc97cccef6", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "claim-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Claim cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "321f830d-ea5e-4808-a6ed-77d0850e6437", "name": "Update claim cause", "request": { "name": "Update claim cause", "description": { "content": "Full replacement of an existing claim cause. Send the `If-Match` header for optimistic concurrency (accepted but ignored ├óÔé¼ÔÇØ not versioned).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "claim-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Claim cause ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "c059de19-b0b8-4fc4-b620-484863a60aac", "name": "Claim cause updated", "originalRequest": { "url": { "path": [ "api", "v2", "claim-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Claim cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d5671039-85c5-454c-9959-9c9be461a231", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "claim-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Claim cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "51e35132-08b3-4521-9e31-d121b0880a41", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "claim-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Claim cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "572a010d-9b1e-4540-81fa-8046626779a2", "name": "Authenticated user is missing the `EDITAR_RECLAMOCAUSANTE` permission", "originalRequest": { "url": { "path": [ "api", "v2", "claim-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Claim cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ee2ba5f2-6f53-4d36-b0ae-0c604f6255d6", "name": "Claim cause not found", "originalRequest": { "url": { "path": [ "api", "v2", "claim-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Claim cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cdcafe81-624b-43bf-b651-487ecbfe95ad", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "claim-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Claim cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2894935a-12dc-4102-a611-588924f01a24", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "claim-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Claim cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "101d8754-bc50-4072-a586-028e7c67bfb6", "name": "Delete claim cause", "request": { "name": "Delete claim cause", "description": { "content": "Deletes a claim cause. Send the `If-Match` header with the current ETag (accepted but ignored ├óÔé¼ÔÇØ not versioned).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "claim-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Claim cause ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "18112ac8-0fe5-42e8-abd7-77eb3bd949f6", "name": "Claim cause deleted", "originalRequest": { "url": { "path": [ "api", "v2", "claim-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Claim cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c4d66906-3d30-4bbb-ada0-bb36c9560e6e", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "claim-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Claim cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2bb05661-fbc7-445b-b298-41c230676214", "name": "Authenticated user is missing the `BORRAR_RECLAMOCAUSANTE` permission", "originalRequest": { "url": { "path": [ "api", "v2", "claim-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Claim cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bd30cc5d-993c-465c-aea2-170e484a36e7", "name": "Claim cause not found", "originalRequest": { "url": { "path": [ "api", "v2", "claim-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Claim cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c195f0c6-67ba-4df6-b056-db69c064b239", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "claim-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Claim cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8b0c4ac0-ae99-4714-b246-c32684f3a3d1", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "claim-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Claim cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7e506776-ab50-4afc-ab92-1cb69bb40ba5", "name": "Merge-patch claim cause", "request": { "name": "Merge-patch claim cause", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "claim-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Claim cause ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "bfaa0725-21cd-4c81-a6c0-e8c0d72ceac5", "name": "Claim cause patched", "originalRequest": { "url": { "path": [ "api", "v2", "claim-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Claim cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "29bf6ad7-609c-4bc6-8a40-46b2fa634d23", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details. Also returned for malformed merge-patch payloads.", "originalRequest": { "url": { "path": [ "api", "v2", "claim-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Claim cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "424b8db5-cc8a-4b70-ae55-7b9351e5a2d2", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "claim-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Claim cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0e43a87a-1813-43f3-9b32-a614bdbba7ea", "name": "Authenticated user is missing the `EDITAR_RECLAMOCAUSANTE` permission", "originalRequest": { "url": { "path": [ "api", "v2", "claim-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Claim cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6bd97d7c-ae09-4346-bf79-981390fe43ba", "name": "Claim cause not found", "originalRequest": { "url": { "path": [ "api", "v2", "claim-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Claim cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b6c67153-fbd5-41cd-84ed-95dc30d62305", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "claim-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Claim cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5467e298-ad97-43c5-9ac6-536c5fbb6197", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "claim-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Claim cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "6946a430-b102-4aed-849e-d5d03c70a9f0", "name": "List claim causes", "request": { "name": "List claim causes", "description": { "content": "Returns a paginated list of claim causes with envelope `{data, totalCount, skip, limit, hasMore}`. Supports optional RSQL `filter`, `sort` (default `name:asc`), `skip`/`limit` pagination and `modifiedAfter`/`modifiedBefore` bookends.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "claim-causes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "c6e1a353-33ce-497e-8ce6-d2043e70cd60", "name": "Page of claim causes", "originalRequest": { "url": { "path": [ "api", "v2", "claim-causes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5f916793-0370-4be2-b82d-390a6c2425f5", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "claim-causes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "15d79680-d336-4b88-bfe5-c3663fd7d552", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "claim-causes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c4c47853-44be-44d4-9c99-254a134c80b1", "name": "Authenticated user is missing the `VER_RECLAMOCAUSANTE` permission", "originalRequest": { "url": { "path": [ "api", "v2", "claim-causes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e4d29cf9-f075-4b3a-90bc-84a9ad631e94", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "claim-causes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "30806e83-3781-4a90-a2a3-b7baff239dc5", "name": "Create claim cause", "request": { "name": "Create claim cause", "description": { "content": "Creates a new claim cause. Business logic runs in the legacy WAR via the internal commands gateway.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "claim-causes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "5839a5d7-22f1-4c85-9548-c92e573d4051", "name": "Claim cause created", "originalRequest": { "url": { "path": [ "api", "v2", "claim-causes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e4c651fb-b318-4b04-83c1-00aad7e47bb3", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "claim-causes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2f38a103-b4c3-49f4-a82a-0ac6f624e4e0", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "claim-causes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0198db80-6345-4545-a428-ad6dae29ee32", "name": "Authenticated user is missing the `CREAR_RECLAMOCAUSANTE` permission", "originalRequest": { "url": { "path": [ "api", "v2", "claim-causes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c1a9f8ac-a048-4a13-b049-5f23fd5a4daf", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "claim-causes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "new", "description": "", "item": [ { "id": "7a2b4f61-6b21-4aad-888e-da08ca6eba0d", "name": "Prototype claim cause for a creation form", "request": { "name": "Prototype claim cause for a creation form", "description": { "content": "Returns a non-persisted claim cause pre-populated with backend defaults (`enabled=true`, current company). Optional JSON hints: `companyId`, `copyFromId`. The response has no `id`, `version` or audit fields; call `POST /api/v2/claim-causes` afterwards to persist.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "claim-causes", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "3a2412ba-c709-4f62-b454-5c28acb7724b", "name": "Claim cause prototype with defaults", "originalRequest": { "url": { "path": [ "api", "v2", "claim-causes", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "025d77cc-f82b-42c0-80ce-ce3112c1c33f", "name": "Invalid prepare-create hints", "originalRequest": { "url": { "path": [ "api", "v2", "claim-causes", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6bf929e0-0d5b-4532-bfc5-e68045307f15", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "claim-causes", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6b101b8b-280a-46ff-887d-415b770c209c", "name": "Authenticated user is missing the `CREAR_RECLAMOCAUSANTE` permission", "originalRequest": { "url": { "path": [ "api", "v2", "claim-causes", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e80720a3-ac4e-4922-9e0c-7d70f42631c1", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "claim-causes", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "categories", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "027de7b5-7d9c-4056-9459-f2e06d8444a3", "name": "Get category by ID", "request": { "name": "Get category by ID", "description": { "content": "Returns a single category by its primary key. The response carries a strong `ETag` header with the current version.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "categories", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Category ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "6a2da690-c118-4002-ad7d-78ea1e25f90e", "name": "Category found", "originalRequest": { "url": { "path": [ "api", "v2", "categories", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Category ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"blocked\": \"\",\n \"parentId\": \"\",\n \"parentName\": \"\",\n \"treeLeft\": \"\",\n \"treeRight\": \"\",\n \"equivalenceSurchargeApplies\": \"\",\n \"requiresPrescription\": \"\",\n \"requiresLot\": \"\",\n \"contactLenses\": \"\",\n \"sunglasses\": \"\",\n \"inventoriable\": \"\",\n \"allowsNegativeStock\": \"\",\n \"allowsReservationWithoutStock\": \"\",\n \"inHouseManufacturing\": \"\",\n \"viewType\": \"\",\n \"productDescriptionPattern\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"articleTypeId\": \"\",\n \"articleTypeName\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5ab32e21-339f-4cad-afde-b7b906216063", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "categories", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Category ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7473ca26-ee1c-4fee-a337-37f7bee323cf", "name": "Authenticated user is missing the `VER_CATEGORIAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "categories", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Category ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "eeb1336a-47bc-40ba-afd8-c23178be75ca", "name": "Category not found", "originalRequest": { "url": { "path": [ "api", "v2", "categories", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Category ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ad5839a9-2168-4d92-ac12-469a1488730b", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "categories", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Category ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "77ec1a47-bfe3-4e78-b4df-558a22b7ef27", "name": "Update category", "request": { "name": "Update category", "description": { "content": "Full replacement of an existing category. Send the `If-Match` header with the current ETag for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "categories", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Category ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"blocked\": \"\",\n \"parentId\": \"\",\n \"equivalenceSurchargeApplies\": \"\",\n \"requiresPrescription\": \"\",\n \"requiresLot\": \"\",\n \"contactLenses\": \"\",\n \"sunglasses\": \"\",\n \"inventoriable\": \"\",\n \"allowsNegativeStock\": \"\",\n \"allowsReservationWithoutStock\": \"\",\n \"inHouseManufacturing\": \"\",\n \"viewType\": \"\",\n \"productDescriptionPattern\": \"\",\n \"companyId\": \"\",\n \"articleTypeId\": \"\",\n \"vatTypeId\": \"\",\n \"expenseAccountId\": \"\",\n \"incomeAccountId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "8114f990-2fb9-4a41-8dae-70a3bef9632a", "name": "Category updated", "originalRequest": { "url": { "path": [ "api", "v2", "categories", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Category ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"blocked\": \"\",\n \"parentId\": \"\",\n \"equivalenceSurchargeApplies\": \"\",\n \"requiresPrescription\": \"\",\n \"requiresLot\": \"\",\n \"contactLenses\": \"\",\n \"sunglasses\": \"\",\n \"inventoriable\": \"\",\n \"allowsNegativeStock\": \"\",\n \"allowsReservationWithoutStock\": \"\",\n \"inHouseManufacturing\": \"\",\n \"viewType\": \"\",\n \"productDescriptionPattern\": \"\",\n \"companyId\": \"\",\n \"articleTypeId\": \"\",\n \"vatTypeId\": \"\",\n \"expenseAccountId\": \"\",\n \"incomeAccountId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"blocked\": \"\",\n \"parentId\": \"\",\n \"parentName\": \"\",\n \"treeLeft\": \"\",\n \"treeRight\": \"\",\n \"equivalenceSurchargeApplies\": \"\",\n \"requiresPrescription\": \"\",\n \"requiresLot\": \"\",\n \"contactLenses\": \"\",\n \"sunglasses\": \"\",\n \"inventoriable\": \"\",\n \"allowsNegativeStock\": \"\",\n \"allowsReservationWithoutStock\": \"\",\n \"inHouseManufacturing\": \"\",\n \"viewType\": \"\",\n \"productDescriptionPattern\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"articleTypeId\": \"\",\n \"articleTypeName\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5297eec0-2a8d-40b9-a25f-a80aecaedfab", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "categories", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Category ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"blocked\": \"\",\n \"parentId\": \"\",\n \"equivalenceSurchargeApplies\": \"\",\n \"requiresPrescription\": \"\",\n \"requiresLot\": \"\",\n \"contactLenses\": \"\",\n \"sunglasses\": \"\",\n \"inventoriable\": \"\",\n \"allowsNegativeStock\": \"\",\n \"allowsReservationWithoutStock\": \"\",\n \"inHouseManufacturing\": \"\",\n \"viewType\": \"\",\n \"productDescriptionPattern\": \"\",\n \"companyId\": \"\",\n \"articleTypeId\": \"\",\n \"vatTypeId\": \"\",\n \"expenseAccountId\": \"\",\n \"incomeAccountId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "93285abc-3710-4d89-82b1-5937547702a2", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "categories", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Category ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"blocked\": \"\",\n \"parentId\": \"\",\n \"equivalenceSurchargeApplies\": \"\",\n \"requiresPrescription\": \"\",\n \"requiresLot\": \"\",\n \"contactLenses\": \"\",\n \"sunglasses\": \"\",\n \"inventoriable\": \"\",\n \"allowsNegativeStock\": \"\",\n \"allowsReservationWithoutStock\": \"\",\n \"inHouseManufacturing\": \"\",\n \"viewType\": \"\",\n \"productDescriptionPattern\": \"\",\n \"companyId\": \"\",\n \"articleTypeId\": \"\",\n \"vatTypeId\": \"\",\n \"expenseAccountId\": \"\",\n \"incomeAccountId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ad9072b3-436e-49b7-935e-7f016d5217bf", "name": "Authenticated user is missing the `EDITAR_CATEGORIAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "categories", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Category ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"blocked\": \"\",\n \"parentId\": \"\",\n \"equivalenceSurchargeApplies\": \"\",\n \"requiresPrescription\": \"\",\n \"requiresLot\": \"\",\n \"contactLenses\": \"\",\n \"sunglasses\": \"\",\n \"inventoriable\": \"\",\n \"allowsNegativeStock\": \"\",\n \"allowsReservationWithoutStock\": \"\",\n \"inHouseManufacturing\": \"\",\n \"viewType\": \"\",\n \"productDescriptionPattern\": \"\",\n \"companyId\": \"\",\n \"articleTypeId\": \"\",\n \"vatTypeId\": \"\",\n \"expenseAccountId\": \"\",\n \"incomeAccountId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c84ad1da-0458-49f7-b617-5ef7f1be2147", "name": "Category not found", "originalRequest": { "url": { "path": [ "api", "v2", "categories", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Category ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"blocked\": \"\",\n \"parentId\": \"\",\n \"equivalenceSurchargeApplies\": \"\",\n \"requiresPrescription\": \"\",\n \"requiresLot\": \"\",\n \"contactLenses\": \"\",\n \"sunglasses\": \"\",\n \"inventoriable\": \"\",\n \"allowsNegativeStock\": \"\",\n \"allowsReservationWithoutStock\": \"\",\n \"inHouseManufacturing\": \"\",\n \"viewType\": \"\",\n \"productDescriptionPattern\": \"\",\n \"companyId\": \"\",\n \"articleTypeId\": \"\",\n \"vatTypeId\": \"\",\n \"expenseAccountId\": \"\",\n \"incomeAccountId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3274eba3-a05b-46c7-b3dd-8a81a26bf699", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "categories", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Category ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"blocked\": \"\",\n \"parentId\": \"\",\n \"equivalenceSurchargeApplies\": \"\",\n \"requiresPrescription\": \"\",\n \"requiresLot\": \"\",\n \"contactLenses\": \"\",\n \"sunglasses\": \"\",\n \"inventoriable\": \"\",\n \"allowsNegativeStock\": \"\",\n \"allowsReservationWithoutStock\": \"\",\n \"inHouseManufacturing\": \"\",\n \"viewType\": \"\",\n \"productDescriptionPattern\": \"\",\n \"companyId\": \"\",\n \"articleTypeId\": \"\",\n \"vatTypeId\": \"\",\n \"expenseAccountId\": \"\",\n \"incomeAccountId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d44153e2-ec73-4dc6-a1cb-f43229b03aff", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "categories", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Category ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"blocked\": \"\",\n \"parentId\": \"\",\n \"equivalenceSurchargeApplies\": \"\",\n \"requiresPrescription\": \"\",\n \"requiresLot\": \"\",\n \"contactLenses\": \"\",\n \"sunglasses\": \"\",\n \"inventoriable\": \"\",\n \"allowsNegativeStock\": \"\",\n \"allowsReservationWithoutStock\": \"\",\n \"inHouseManufacturing\": \"\",\n \"viewType\": \"\",\n \"productDescriptionPattern\": \"\",\n \"companyId\": \"\",\n \"articleTypeId\": \"\",\n \"vatTypeId\": \"\",\n \"expenseAccountId\": \"\",\n \"incomeAccountId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9ad3ebc6-265a-4200-82d4-81e129f05e5b", "name": "Delete category", "request": { "name": "Delete category", "description": { "content": "Deletes a category. Send the `If-Match` header with the current ETag for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "categories", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Category ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "618b2705-719d-4bbc-aaee-26a9dff77311", "name": "Category deleted", "originalRequest": { "url": { "path": [ "api", "v2", "categories", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Category ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "60ebda05-6fb0-48c1-86da-89be2b43b050", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "categories", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Category ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e087dfb4-04a1-4770-bea2-faca04720787", "name": "Authenticated user is missing the `BORRAR_CATEGORIAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "categories", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Category ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9f76f8cf-3be6-4161-9f5a-8f796091661d", "name": "Category not found", "originalRequest": { "url": { "path": [ "api", "v2", "categories", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Category ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "869425f4-1c42-4e4d-9a9d-3d1de17776c6", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "categories", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Category ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "65781ee1-875f-45b9-af02-ceed6818383d", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "categories", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Category ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7288d045-8328-4654-9342-0f11537662e2", "name": "Merge-patch category", "request": { "name": "Merge-patch category", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "categories", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Category ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "8c8916d9-06cf-4587-8b70-77cb17a7458a", "name": "Category patched", "originalRequest": { "url": { "path": [ "api", "v2", "categories", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Category ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"blocked\": \"\",\n \"parentId\": \"\",\n \"parentName\": \"\",\n \"treeLeft\": \"\",\n \"treeRight\": \"\",\n \"equivalenceSurchargeApplies\": \"\",\n \"requiresPrescription\": \"\",\n \"requiresLot\": \"\",\n \"contactLenses\": \"\",\n \"sunglasses\": \"\",\n \"inventoriable\": \"\",\n \"allowsNegativeStock\": \"\",\n \"allowsReservationWithoutStock\": \"\",\n \"inHouseManufacturing\": \"\",\n \"viewType\": \"\",\n \"productDescriptionPattern\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"articleTypeId\": \"\",\n \"articleTypeName\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c5a16207-d047-4b32-afb5-f808d96a10de", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details. Also returned for malformed merge-patch payloads.", "originalRequest": { "url": { "path": [ "api", "v2", "categories", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Category ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "49842b40-50af-4b4f-9ad3-bee013a964e0", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "categories", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Category ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0a98daac-133b-49d8-a184-eec208b674f4", "name": "Authenticated user is missing the `EDITAR_CATEGORIAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "categories", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Category ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "93792ed5-1991-45e1-a56f-3830e482defe", "name": "Category not found", "originalRequest": { "url": { "path": [ "api", "v2", "categories", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Category ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d257fb53-c827-4a0d-acaf-2253be18d8ad", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "categories", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Category ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0718db20-8d91-4d89-bb63-13035d730709", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "categories", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Category ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "9ceb7dfc-1a27-4d70-84ad-697757f0f1a1", "name": "List categories", "request": { "name": "List categories", "description": { "content": "Returns a paginated list of categories with envelope `{data, totalCount, skip, limit, hasMore}`. Default sort is `treeLeft:asc` so the result is naturally tree-ordered. Use `filter=parentId=null=` to fetch roots, or `filter=parentId==42` to fetch the direct children of a given parent.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "categories" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "treeLeft:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "b0456988-e8d9-4ee8-acfd-e282b2daf5a8", "name": "Page of categories", "originalRequest": { "url": { "path": [ "api", "v2", "categories" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "treeLeft:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6bcee60b-2c36-40e5-96c6-77cfa9295e72", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "categories" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "treeLeft:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ccbe842c-cf2e-4adb-8d39-4f2f3d952295", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "categories" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "treeLeft:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2b69f267-7d1d-4fc4-9176-b89dc09109eb", "name": "Authenticated user is missing the `VER_CATEGORIAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "categories" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "treeLeft:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d5d481e9-14df-4b67-91cb-4168039d8cd8", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "categories" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "treeLeft:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "57f23857-7bd6-4313-8815-aa1fb63b3227", "name": "Create category", "request": { "name": "Create category", "description": { "content": "Creates a new category. Use `parentId` to attach it under an existing parent (omit for a root). Business logic runs in the legacy WAR via the internal commands gateway.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "categories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"blocked\": \"\",\n \"parentId\": \"\",\n \"equivalenceSurchargeApplies\": \"\",\n \"requiresPrescription\": \"\",\n \"requiresLot\": \"\",\n \"contactLenses\": \"\",\n \"sunglasses\": \"\",\n \"inventoriable\": \"\",\n \"allowsNegativeStock\": \"\",\n \"allowsReservationWithoutStock\": \"\",\n \"inHouseManufacturing\": \"\",\n \"viewType\": \"\",\n \"productDescriptionPattern\": \"\",\n \"companyId\": \"\",\n \"articleTypeId\": \"\",\n \"vatTypeId\": \"\",\n \"expenseAccountId\": \"\",\n \"incomeAccountId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "47e86a70-707b-4ca9-85c9-25741934460c", "name": "Category created", "originalRequest": { "url": { "path": [ "api", "v2", "categories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"blocked\": \"\",\n \"parentId\": \"\",\n \"equivalenceSurchargeApplies\": \"\",\n \"requiresPrescription\": \"\",\n \"requiresLot\": \"\",\n \"contactLenses\": \"\",\n \"sunglasses\": \"\",\n \"inventoriable\": \"\",\n \"allowsNegativeStock\": \"\",\n \"allowsReservationWithoutStock\": \"\",\n \"inHouseManufacturing\": \"\",\n \"viewType\": \"\",\n \"productDescriptionPattern\": \"\",\n \"companyId\": \"\",\n \"articleTypeId\": \"\",\n \"vatTypeId\": \"\",\n \"expenseAccountId\": \"\",\n \"incomeAccountId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"blocked\": \"\",\n \"parentId\": \"\",\n \"parentName\": \"\",\n \"treeLeft\": \"\",\n \"treeRight\": \"\",\n \"equivalenceSurchargeApplies\": \"\",\n \"requiresPrescription\": \"\",\n \"requiresLot\": \"\",\n \"contactLenses\": \"\",\n \"sunglasses\": \"\",\n \"inventoriable\": \"\",\n \"allowsNegativeStock\": \"\",\n \"allowsReservationWithoutStock\": \"\",\n \"inHouseManufacturing\": \"\",\n \"viewType\": \"\",\n \"productDescriptionPattern\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"articleTypeId\": \"\",\n \"articleTypeName\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9c69b970-1255-440e-b66a-6162f8f86616", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "categories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"blocked\": \"\",\n \"parentId\": \"\",\n \"equivalenceSurchargeApplies\": \"\",\n \"requiresPrescription\": \"\",\n \"requiresLot\": \"\",\n \"contactLenses\": \"\",\n \"sunglasses\": \"\",\n \"inventoriable\": \"\",\n \"allowsNegativeStock\": \"\",\n \"allowsReservationWithoutStock\": \"\",\n \"inHouseManufacturing\": \"\",\n \"viewType\": \"\",\n \"productDescriptionPattern\": \"\",\n \"companyId\": \"\",\n \"articleTypeId\": \"\",\n \"vatTypeId\": \"\",\n \"expenseAccountId\": \"\",\n \"incomeAccountId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2c0375d8-be1a-40e4-b3e7-0fa96f8659f9", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "categories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"blocked\": \"\",\n \"parentId\": \"\",\n \"equivalenceSurchargeApplies\": \"\",\n \"requiresPrescription\": \"\",\n \"requiresLot\": \"\",\n \"contactLenses\": \"\",\n \"sunglasses\": \"\",\n \"inventoriable\": \"\",\n \"allowsNegativeStock\": \"\",\n \"allowsReservationWithoutStock\": \"\",\n \"inHouseManufacturing\": \"\",\n \"viewType\": \"\",\n \"productDescriptionPattern\": \"\",\n \"companyId\": \"\",\n \"articleTypeId\": \"\",\n \"vatTypeId\": \"\",\n \"expenseAccountId\": \"\",\n \"incomeAccountId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "818c08ca-5ee2-44c7-a335-5dff3578184c", "name": "Authenticated user is missing the `CREAR_CATEGORIAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "categories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"blocked\": \"\",\n \"parentId\": \"\",\n \"equivalenceSurchargeApplies\": \"\",\n \"requiresPrescription\": \"\",\n \"requiresLot\": \"\",\n \"contactLenses\": \"\",\n \"sunglasses\": \"\",\n \"inventoriable\": \"\",\n \"allowsNegativeStock\": \"\",\n \"allowsReservationWithoutStock\": \"\",\n \"inHouseManufacturing\": \"\",\n \"viewType\": \"\",\n \"productDescriptionPattern\": \"\",\n \"companyId\": \"\",\n \"articleTypeId\": \"\",\n \"vatTypeId\": \"\",\n \"expenseAccountId\": \"\",\n \"incomeAccountId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5da513c2-af29-4edf-85a5-e810d85813d7", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "categories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"blocked\": \"\",\n \"parentId\": \"\",\n \"equivalenceSurchargeApplies\": \"\",\n \"requiresPrescription\": \"\",\n \"requiresLot\": \"\",\n \"contactLenses\": \"\",\n \"sunglasses\": \"\",\n \"inventoriable\": \"\",\n \"allowsNegativeStock\": \"\",\n \"allowsReservationWithoutStock\": \"\",\n \"inHouseManufacturing\": \"\",\n \"viewType\": \"\",\n \"productDescriptionPattern\": \"\",\n \"companyId\": \"\",\n \"articleTypeId\": \"\",\n \"vatTypeId\": \"\",\n \"expenseAccountId\": \"\",\n \"incomeAccountId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "new", "description": "", "item": [ { "id": "dfbcf58a-da04-425f-a9fc-09d2fab5c1bf", "name": "Prototype category for a creation form", "request": { "name": "Prototype category for a creation form", "description": { "content": "Returns a non-persisted category pre-populated with backend defaults for the authenticated user. Optional hints include `companyId`, `parentId`, `articleTypeId`, `vatTypeId`, `expenseAccountId`, `incomeAccountId` and `copyFromId`. The response has no `id`, `version` or audit fields; call `POST /api/v2/categories` afterwards to persist it.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "categories", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "4eb39957-a16a-4eb6-b0df-0fe624ae3d5c", "name": "Category prototype with defaults", "originalRequest": { "url": { "path": [ "api", "v2", "categories", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"blocked\": \"\",\n \"parentId\": \"\",\n \"parentName\": \"\",\n \"treeLeft\": \"\",\n \"treeRight\": \"\",\n \"equivalenceSurchargeApplies\": \"\",\n \"requiresPrescription\": \"\",\n \"requiresLot\": \"\",\n \"contactLenses\": \"\",\n \"sunglasses\": \"\",\n \"inventoriable\": \"\",\n \"allowsNegativeStock\": \"\",\n \"allowsReservationWithoutStock\": \"\",\n \"inHouseManufacturing\": \"\",\n \"viewType\": \"\",\n \"productDescriptionPattern\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"articleTypeId\": \"\",\n \"articleTypeName\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"expenseAccountId\": \"\",\n \"expenseAccountName\": \"\",\n \"incomeAccountId\": \"\",\n \"incomeAccountName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a1e44d5f-4dcd-4b05-82dd-4eaf7b3afadf", "name": "Invalid prepare-create hints", "originalRequest": { "url": { "path": [ "api", "v2", "categories", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2fe3ff72-54cd-4e79-acf1-0e505285ae28", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "categories", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "986894f9-0882-4bb0-beab-c496a20fd5ac", "name": "Authenticated user is missing the `CREAR_CATEGORIAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "categories", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3e4d472a-5892-4eac-85d8-838a90be40f4", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "categories", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "cash-closes", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "28d64a72-e58e-4bf0-a8fe-87a80fe0b4fb", "name": "Get cash close by ID", "request": { "name": "Get cash close by ID", "description": { "content": "Returns a single cash close including payment-method lines and optional cash withdrawals.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "cash-closes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Cash close ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "6d8d2cc1-5bab-4454-8764-34151d309f7b", "name": "Cash close found", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cash close ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"closeAt\": \"\",\n \"warehouseId\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"closeType\": \"N\",\n \"open\": \"\",\n \"periodStartAt\": \"\",\n \"periodEndAt\": \"\",\n \"incomeAmount\": \"\",\n \"outgoingAmount\": \"\",\n \"calculatedAmount\": \"\",\n \"countedAmount\": \"\",\n \"depositAmount\": \"\",\n \"previousCashBalance\": \"\",\n \"cashBalance\": \"\",\n \"changeKeptInRegister\": \"\",\n \"vouchersIssuedAmount\": \"\",\n \"finalBalance\": \"\",\n \"warehouseName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"withdrawalJournalEntryId\": \"\",\n \"lines\": [\n {\n \"id\": \"\",\n \"cashCloseId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentKind\": \"D\",\n \"incomeAmount\": \"\",\n \"outgoingAmount\": \"\",\n \"calculatedAmount\": \"\",\n \"countedAmount\": \"\"\n },\n {\n \"id\": \"\",\n \"cashCloseId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentKind\": \"D\",\n \"incomeAmount\": \"\",\n \"outgoingAmount\": \"\",\n \"calculatedAmount\": \"\",\n \"countedAmount\": \"\"\n }\n ],\n \"withdrawals\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"MC\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"CP\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\",\n \"zreportNumber\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "65cd8f61-a0e6-4617-81e7-3e71173121cf", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cash close ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3809153d-ae5c-4cbd-9c21-a94d4974c183", "name": "Authenticated user is missing the `VER_CAJAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cash close ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "152af574-55d6-4ef1-9340-13c216210ee7", "name": "Cash close not found", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cash close ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "79b1cdd2-5cf8-4b6f-91ed-3d3be71a0915", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cash close ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fc3ae0cb-1def-4f4e-9905-24d79451206d", "name": "Update cash close", "request": { "name": "Update cash close", "description": { "content": "Full replacement of an existing cash close. `warehouseId` is immutable. When balances change, the legacy facade propagates subsequent closes via `updateNextSaldosCaja`.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "cash-closes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Cash close ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"closeAt\": \"\",\n \"warehouseId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"closeType\": \"I\",\n \"open\": \"\",\n \"changeKeptInRegister\": \"\",\n \"lines\": [\n {\n \"paymentMethodId\": \"\",\n \"countedAmount\": \"\"\n },\n {\n \"paymentMethodId\": \"\",\n \"countedAmount\": \"\"\n }\n ],\n \"withdrawals\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"RI\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"needsRecalculation\": \"\",\n \"zreportNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "193e69ff-88ea-4bcb-b94d-b665927ead33", "name": "Cash close updated", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cash close ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"closeAt\": \"\",\n \"warehouseId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"closeType\": \"I\",\n \"open\": \"\",\n \"changeKeptInRegister\": \"\",\n \"lines\": [\n {\n \"paymentMethodId\": \"\",\n \"countedAmount\": \"\"\n },\n {\n \"paymentMethodId\": \"\",\n \"countedAmount\": \"\"\n }\n ],\n \"withdrawals\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"RI\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"needsRecalculation\": \"\",\n \"zreportNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"closeAt\": \"\",\n \"warehouseId\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"closeType\": \"N\",\n \"open\": \"\",\n \"periodStartAt\": \"\",\n \"periodEndAt\": \"\",\n \"incomeAmount\": \"\",\n \"outgoingAmount\": \"\",\n \"calculatedAmount\": \"\",\n \"countedAmount\": \"\",\n \"depositAmount\": \"\",\n \"previousCashBalance\": \"\",\n \"cashBalance\": \"\",\n \"changeKeptInRegister\": \"\",\n \"vouchersIssuedAmount\": \"\",\n \"finalBalance\": \"\",\n \"warehouseName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"withdrawalJournalEntryId\": \"\",\n \"lines\": [\n {\n \"id\": \"\",\n \"cashCloseId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentKind\": \"D\",\n \"incomeAmount\": \"\",\n \"outgoingAmount\": \"\",\n \"calculatedAmount\": \"\",\n \"countedAmount\": \"\"\n },\n {\n \"id\": \"\",\n \"cashCloseId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentKind\": \"D\",\n \"incomeAmount\": \"\",\n \"outgoingAmount\": \"\",\n \"calculatedAmount\": \"\",\n \"countedAmount\": \"\"\n }\n ],\n \"withdrawals\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"MC\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"CP\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\",\n \"zreportNumber\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b91ac006-41ed-4707-a26e-b1ae39c4d688", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cash close ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"closeAt\": \"\",\n \"warehouseId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"closeType\": \"I\",\n \"open\": \"\",\n \"changeKeptInRegister\": \"\",\n \"lines\": [\n {\n \"paymentMethodId\": \"\",\n \"countedAmount\": \"\"\n },\n {\n \"paymentMethodId\": \"\",\n \"countedAmount\": \"\"\n }\n ],\n \"withdrawals\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"RI\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"needsRecalculation\": \"\",\n \"zreportNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "61bd2815-20c2-49e1-93e4-53e5b72dedc2", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cash close ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"closeAt\": \"\",\n \"warehouseId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"closeType\": \"I\",\n \"open\": \"\",\n \"changeKeptInRegister\": \"\",\n \"lines\": [\n {\n \"paymentMethodId\": \"\",\n \"countedAmount\": \"\"\n },\n {\n \"paymentMethodId\": \"\",\n \"countedAmount\": \"\"\n }\n ],\n \"withdrawals\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"RI\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"needsRecalculation\": \"\",\n \"zreportNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d02f8947-022d-4794-bc46-58f88c3cf0c6", "name": "Authenticated user is missing the `EDITAR_CAJAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cash close ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"closeAt\": \"\",\n \"warehouseId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"closeType\": \"I\",\n \"open\": \"\",\n \"changeKeptInRegister\": \"\",\n \"lines\": [\n {\n \"paymentMethodId\": \"\",\n \"countedAmount\": \"\"\n },\n {\n \"paymentMethodId\": \"\",\n \"countedAmount\": \"\"\n }\n ],\n \"withdrawals\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"RI\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"needsRecalculation\": \"\",\n \"zreportNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f15cc5d6-67d9-4e8c-876e-4c622027aecc", "name": "Cash close not found", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cash close ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"closeAt\": \"\",\n \"warehouseId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"closeType\": \"I\",\n \"open\": \"\",\n \"changeKeptInRegister\": \"\",\n \"lines\": [\n {\n \"paymentMethodId\": \"\",\n \"countedAmount\": \"\"\n },\n {\n \"paymentMethodId\": \"\",\n \"countedAmount\": \"\"\n }\n ],\n \"withdrawals\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"RI\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"needsRecalculation\": \"\",\n \"zreportNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b57e86cf-d3d9-4129-8f11-274b710b107c", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cash close ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"closeAt\": \"\",\n \"warehouseId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"closeType\": \"I\",\n \"open\": \"\",\n \"changeKeptInRegister\": \"\",\n \"lines\": [\n {\n \"paymentMethodId\": \"\",\n \"countedAmount\": \"\"\n },\n {\n \"paymentMethodId\": \"\",\n \"countedAmount\": \"\"\n }\n ],\n \"withdrawals\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"RI\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"needsRecalculation\": \"\",\n \"zreportNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bbaea173-9457-489c-85b1-1a7d2ac1c80c", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cash close ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"closeAt\": \"\",\n \"warehouseId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"closeType\": \"I\",\n \"open\": \"\",\n \"changeKeptInRegister\": \"\",\n \"lines\": [\n {\n \"paymentMethodId\": \"\",\n \"countedAmount\": \"\"\n },\n {\n \"paymentMethodId\": \"\",\n \"countedAmount\": \"\"\n }\n ],\n \"withdrawals\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"RI\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"needsRecalculation\": \"\",\n \"zreportNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "082a4418-1337-47d7-94ce-2ac5a1f290f6", "name": "Delete cash close", "request": { "name": "Delete cash close", "description": { "content": "Deletes a cash close. Closed registers with withdrawals are re-opened in the legacy flow before deletion.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "cash-closes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Cash close ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "bc49da59-a39b-4b6d-be92-a3d7211209e4", "name": "Cash close deleted", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cash close ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8f87c662-14f2-42c7-a347-ee34eb870752", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cash close ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d44484eb-370b-49b6-a9e4-b2ea2871f632", "name": "Authenticated user is missing the `BORRAR_CAJAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cash close ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "81315578-ff0a-4948-92ac-2e174f90cded", "name": "Cash close not found", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cash close ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "449f6b77-034e-4575-8ddb-274d387d8654", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cash close ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b983443e-58b1-4842-ae3e-86e26125cb84", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cash close ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fe80f56f-3dd7-4e98-9c4d-0402cfd2b8f0", "name": "Merge-patch cash close", "request": { "name": "Merge-patch cash close", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "cash-closes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Cash close ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "c3c56d9c-4959-47f9-82ba-92ca7676083e", "name": "Cash close patched", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cash close ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"closeAt\": \"\",\n \"warehouseId\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"closeType\": \"N\",\n \"open\": \"\",\n \"periodStartAt\": \"\",\n \"periodEndAt\": \"\",\n \"incomeAmount\": \"\",\n \"outgoingAmount\": \"\",\n \"calculatedAmount\": \"\",\n \"countedAmount\": \"\",\n \"depositAmount\": \"\",\n \"previousCashBalance\": \"\",\n \"cashBalance\": \"\",\n \"changeKeptInRegister\": \"\",\n \"vouchersIssuedAmount\": \"\",\n \"finalBalance\": \"\",\n \"warehouseName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"withdrawalJournalEntryId\": \"\",\n \"lines\": [\n {\n \"id\": \"\",\n \"cashCloseId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentKind\": \"D\",\n \"incomeAmount\": \"\",\n \"outgoingAmount\": \"\",\n \"calculatedAmount\": \"\",\n \"countedAmount\": \"\"\n },\n {\n \"id\": \"\",\n \"cashCloseId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentKind\": \"D\",\n \"incomeAmount\": \"\",\n \"outgoingAmount\": \"\",\n \"calculatedAmount\": \"\",\n \"countedAmount\": \"\"\n }\n ],\n \"withdrawals\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"MC\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"CP\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\",\n \"zreportNumber\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "16c07038-ab10-4c4b-9165-995a169ba1e9", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cash close ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b0071d6d-95c7-4cd0-8f52-ee1f2b2c139d", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cash close ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a80a9d09-d016-4ca1-aed4-939f973b0416", "name": "Authenticated user is missing the `EDITAR_CAJAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cash close ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "82cf0cb5-312a-4dfc-a874-f09fe30074b0", "name": "Cash close not found", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cash close ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0124b6fd-3de5-46ce-b64a-7a48adefc42d", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cash close ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ed1e0241-ac6b-4a7e-9c74-db1ec00052d3", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cash close ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "calculate", "description": "", "item": [ { "id": "f9133e2d-51e6-4e73-9ef4-b9b64469bc55", "name": "Calculate cash close totals", "request": { "name": "Calculate cash close totals", "description": { "content": "Recomputes payment-method totals and period boundaries from underlying `Cobro` rows ({@code CajaService.calcularCierre}). Does not persist ÔÇö call PUT/POST afterwards to save counts and withdrawals.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "cash-closes", ":id", "calculate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Cash close ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "c5acec94-a417-43b5-abaf-0cfe28b167a9", "name": "Calculated cash close (not persisted)", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes", ":id", "calculate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cash close ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"closeAt\": \"\",\n \"warehouseId\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"closeType\": \"N\",\n \"open\": \"\",\n \"periodStartAt\": \"\",\n \"periodEndAt\": \"\",\n \"incomeAmount\": \"\",\n \"outgoingAmount\": \"\",\n \"calculatedAmount\": \"\",\n \"countedAmount\": \"\",\n \"depositAmount\": \"\",\n \"previousCashBalance\": \"\",\n \"cashBalance\": \"\",\n \"changeKeptInRegister\": \"\",\n \"vouchersIssuedAmount\": \"\",\n \"finalBalance\": \"\",\n \"warehouseName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"withdrawalJournalEntryId\": \"\",\n \"lines\": [\n {\n \"id\": \"\",\n \"cashCloseId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentKind\": \"D\",\n \"incomeAmount\": \"\",\n \"outgoingAmount\": \"\",\n \"calculatedAmount\": \"\",\n \"countedAmount\": \"\"\n },\n {\n \"id\": \"\",\n \"cashCloseId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentKind\": \"D\",\n \"incomeAmount\": \"\",\n \"outgoingAmount\": \"\",\n \"calculatedAmount\": \"\",\n \"countedAmount\": \"\"\n }\n ],\n \"withdrawals\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"MC\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"CP\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\",\n \"zreportNumber\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "11958a5f-bfa3-4351-80b8-2524eb59c103", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes", ":id", "calculate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cash close ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "66644ab2-8aaf-46f5-9a0c-036c3218469e", "name": "Authenticated user is missing the `EDITAR_CAJAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes", ":id", "calculate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cash close ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "572859bc-7bdb-4168-a3fe-f69ae5ef6de8", "name": "Cash close not found", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes", ":id", "calculate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cash close ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c90ab244-8c2a-4a42-af8c-5b4bdbb20f4f", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes", ":id", "calculate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cash close ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "id": "7c40f50d-0271-4aad-a06c-055c23910444", "name": "List cash closes", "request": { "name": "List cash closes", "description": { "content": "Returns a paginated list of cash register closes. Mirror the legacy JSF list defaults with `filter=draft==false;closeType==N` (limited users only see normal closes, not opening balances). Use `open==true` or `open==false` to list open or closed periods.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "cash-closes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "closeAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "c3d9c4ec-9bf2-4e51-9ecc-eb31ab7394da", "name": "Page of cash closes", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "closeAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "09200cc1-109f-4e71-9d89-e838edb0a8f9", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "closeAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6184fbbf-3a70-4d4a-838a-909cc6fbcee7", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "closeAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cbff2372-0837-48ae-89e0-5c2b5e489ba1", "name": "Authenticated user is missing the `VER_CAJAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "closeAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "886beb87-eb30-4861-b40b-423a874c742a", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "closeAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6db9681f-855c-4f0e-b849-3e14e0154298", "name": "Create cash close", "request": { "name": "Create cash close", "description": { "content": "Creates and optionally closes a cash register period. Set `needsRecalculation=true` (or call calculate first) when `closeAt` changed so totals are refreshed from underlying payments. Writable line fields: `countedAmount` per payment method; `withdrawals` when the branch tracks register withdrawals.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "cash-closes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"closeAt\": \"\",\n \"warehouseId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"closeType\": \"I\",\n \"open\": \"\",\n \"changeKeptInRegister\": \"\",\n \"lines\": [\n {\n \"paymentMethodId\": \"\",\n \"countedAmount\": \"\"\n },\n {\n \"paymentMethodId\": \"\",\n \"countedAmount\": \"\"\n }\n ],\n \"withdrawals\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"RI\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"needsRecalculation\": \"\",\n \"zreportNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "8ac2bb30-3a47-4e64-b486-89a22c81a99e", "name": "Cash close created", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"closeAt\": \"\",\n \"warehouseId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"closeType\": \"I\",\n \"open\": \"\",\n \"changeKeptInRegister\": \"\",\n \"lines\": [\n {\n \"paymentMethodId\": \"\",\n \"countedAmount\": \"\"\n },\n {\n \"paymentMethodId\": \"\",\n \"countedAmount\": \"\"\n }\n ],\n \"withdrawals\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"RI\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"needsRecalculation\": \"\",\n \"zreportNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"closeAt\": \"\",\n \"warehouseId\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"closeType\": \"N\",\n \"open\": \"\",\n \"periodStartAt\": \"\",\n \"periodEndAt\": \"\",\n \"incomeAmount\": \"\",\n \"outgoingAmount\": \"\",\n \"calculatedAmount\": \"\",\n \"countedAmount\": \"\",\n \"depositAmount\": \"\",\n \"previousCashBalance\": \"\",\n \"cashBalance\": \"\",\n \"changeKeptInRegister\": \"\",\n \"vouchersIssuedAmount\": \"\",\n \"finalBalance\": \"\",\n \"warehouseName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"withdrawalJournalEntryId\": \"\",\n \"lines\": [\n {\n \"id\": \"\",\n \"cashCloseId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentKind\": \"D\",\n \"incomeAmount\": \"\",\n \"outgoingAmount\": \"\",\n \"calculatedAmount\": \"\",\n \"countedAmount\": \"\"\n },\n {\n \"id\": \"\",\n \"cashCloseId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentKind\": \"D\",\n \"incomeAmount\": \"\",\n \"outgoingAmount\": \"\",\n \"calculatedAmount\": \"\",\n \"countedAmount\": \"\"\n }\n ],\n \"withdrawals\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"MC\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"CP\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\",\n \"zreportNumber\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ac376ebd-0295-46fd-9ba0-3c2b57af97cd", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"closeAt\": \"\",\n \"warehouseId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"closeType\": \"I\",\n \"open\": \"\",\n \"changeKeptInRegister\": \"\",\n \"lines\": [\n {\n \"paymentMethodId\": \"\",\n \"countedAmount\": \"\"\n },\n {\n \"paymentMethodId\": \"\",\n \"countedAmount\": \"\"\n }\n ],\n \"withdrawals\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"RI\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"needsRecalculation\": \"\",\n \"zreportNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "82b05158-8f5d-41bf-8d61-d39321a4d1fc", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"closeAt\": \"\",\n \"warehouseId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"closeType\": \"I\",\n \"open\": \"\",\n \"changeKeptInRegister\": \"\",\n \"lines\": [\n {\n \"paymentMethodId\": \"\",\n \"countedAmount\": \"\"\n },\n {\n \"paymentMethodId\": \"\",\n \"countedAmount\": \"\"\n }\n ],\n \"withdrawals\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"RI\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"needsRecalculation\": \"\",\n \"zreportNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0f01e07e-fb9c-4319-92b2-e1f201843e69", "name": "Authenticated user is missing the `CREAR_CAJAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"closeAt\": \"\",\n \"warehouseId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"closeType\": \"I\",\n \"open\": \"\",\n \"changeKeptInRegister\": \"\",\n \"lines\": [\n {\n \"paymentMethodId\": \"\",\n \"countedAmount\": \"\"\n },\n {\n \"paymentMethodId\": \"\",\n \"countedAmount\": \"\"\n }\n ],\n \"withdrawals\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"RI\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"needsRecalculation\": \"\",\n \"zreportNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a229c503-97af-4214-8c8a-28cccea5942e", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"closeAt\": \"\",\n \"warehouseId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"closeType\": \"I\",\n \"open\": \"\",\n \"changeKeptInRegister\": \"\",\n \"lines\": [\n {\n \"paymentMethodId\": \"\",\n \"countedAmount\": \"\"\n },\n {\n \"paymentMethodId\": \"\",\n \"countedAmount\": \"\"\n }\n ],\n \"withdrawals\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"RI\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"needsRecalculation\": \"\",\n \"zreportNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{closeId}", "description": "", "item": [ { "name": "withdrawals", "description": "", "item": [ { "name": "{withdrawalId}", "description": "", "item": [ { "name": "attachment", "description": "", "item": [ { "id": "a76752b5-f5e7-4cb5-8dca-b3db89eb6292", "name": "Download withdrawal photo", "request": { "name": "Download withdrawal photo", "description": { "content": "Streams the deposit receipt image attached to a cash withdrawal.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "cash-closes", ":closeId", "withdrawals", ":withdrawalId", "attachment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "closeId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "withdrawalId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "0ea4f4e0-2062-4b92-a5f2-4158cb21f8e0", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes", ":closeId", "withdrawals", ":withdrawalId", "attachment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "closeId" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "withdrawalId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7f1a2fcd-0f68-47c0-97da-25985e9c5326", "name": "Cash close, withdrawal or attachment not found", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes", ":closeId", "withdrawals", ":withdrawalId", "attachment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "closeId" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "withdrawalId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5b1e8cd5-32be-4616-90eb-52d7ae12c3a6", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes", ":closeId", "withdrawals", ":withdrawalId", "attachment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "closeId" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "withdrawalId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d1ed14a3-461f-4481-a80b-68c4e81023b3", "name": "Upload withdrawal photo", "request": { "name": "Upload withdrawal photo", "description": { "content": "Stores a deposit receipt image for a cash withdrawal linked to this close. Accepts .gif, .jpg, .jpeg and .png up to 5 MiB (parity with JSF movCajaForm).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "cash-closes", ":closeId", "withdrawals", ":withdrawalId", "attachment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "closeId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "withdrawalId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Deposit receipt image", "type": "text/plain" }, "key": "file", "type": "file" } ] }, "auth": null }, "response": [ { "id": "d4bbe9fa-fd1b-44ac-ab32-c9a2ce156c99", "name": "Attachment stored", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes", ":closeId", "withdrawals", ":withdrawalId", "attachment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "closeId" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "withdrawalId" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Deposit receipt image", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c5cd719b-4b92-4da3-ae75-78bb3ff3c040", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes", ":closeId", "withdrawals", ":withdrawalId", "attachment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "closeId" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "withdrawalId" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Deposit receipt image", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "caf30f12-a00b-4761-97ce-26ab1d7d6cc9", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes", ":closeId", "withdrawals", ":withdrawalId", "attachment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "closeId" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "withdrawalId" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Deposit receipt image", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8b2807bf-c7e5-4e2d-8e23-11903001619b", "name": "Delete withdrawal photo", "request": { "name": "Delete withdrawal photo", "description": { "content": "Removes the deposit receipt image from a cash withdrawal.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "cash-closes", ":closeId", "withdrawals", ":withdrawalId", "attachment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "closeId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "withdrawalId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "6f180bf8-9877-4095-be66-3c4700ce8a46", "name": "Attachment deleted", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes", ":closeId", "withdrawals", ":withdrawalId", "attachment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "closeId" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "withdrawalId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1298a1b3-2b91-42db-acc2-7928cf19d95f", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes", ":closeId", "withdrawals", ":withdrawalId", "attachment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "closeId" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "withdrawalId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f4acb0cd-221c-4da9-906a-e222b18a5baf", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes", ":closeId", "withdrawals", ":withdrawalId", "attachment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "closeId" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "withdrawalId" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] } ] }, { "name": "new", "description": "", "item": [ { "id": "634505be-06a4-4a6c-a474-87d84c38eae5", "name": "Prototype cash close for a creation form", "request": { "name": "Prototype cash close for a creation form", "description": { "content": "Returns a non-persisted cash close with backend defaults (branch, default close datetime, open=true). Optional JSON hints: `warehouseId`. Call `POST /api/v2/cash-closes` to persist.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "cash-closes", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "4ee1bb74-c4b6-4940-b022-2f9e90eda5cf", "name": "Cash close prototype with defaults", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"closeAt\": \"\",\n \"warehouseId\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"closeType\": \"N\",\n \"open\": \"\",\n \"periodStartAt\": \"\",\n \"periodEndAt\": \"\",\n \"incomeAmount\": \"\",\n \"outgoingAmount\": \"\",\n \"calculatedAmount\": \"\",\n \"countedAmount\": \"\",\n \"depositAmount\": \"\",\n \"previousCashBalance\": \"\",\n \"cashBalance\": \"\",\n \"changeKeptInRegister\": \"\",\n \"vouchersIssuedAmount\": \"\",\n \"finalBalance\": \"\",\n \"warehouseName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"withdrawalJournalEntryId\": \"\",\n \"lines\": [\n {\n \"id\": \"\",\n \"cashCloseId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentKind\": \"D\",\n \"incomeAmount\": \"\",\n \"outgoingAmount\": \"\",\n \"calculatedAmount\": \"\",\n \"countedAmount\": \"\"\n },\n {\n \"id\": \"\",\n \"cashCloseId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentKind\": \"D\",\n \"incomeAmount\": \"\",\n \"outgoingAmount\": \"\",\n \"calculatedAmount\": \"\",\n \"countedAmount\": \"\"\n }\n ],\n \"withdrawals\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"MC\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"CP\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\",\n \"zreportNumber\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ecf07459-3e5b-4600-a12f-f991fb93b13c", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9fcdb816-d014-453d-9892-522b2b017c94", "name": "Authenticated user is missing the `CREAR_CAJAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "eda7f612-8047-4611-b29c-e3211a6254f3", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "calculate", "description": "", "item": [ { "id": "86e8cd6d-9e8a-432d-b2d9-e2f283890972", "name": "Calculate cash close totals (stateless)", "request": { "name": "Calculate cash close totals (stateless)", "description": { "content": "Recomputes payment-method totals for a not-yet-persisted cash close. Send a {@link CashCloseDocument} without {@code id} (at minimum {@code warehouseId} and {@code closeAt}). Parity with the legacy JSF \"Calcular\" action before the first save. Does not persist.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "cash-closes", "calculate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"closeAt\": \"\",\n \"warehouseId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"closeType\": \"I\",\n \"open\": \"\",\n \"changeKeptInRegister\": \"\",\n \"lines\": [\n {\n \"paymentMethodId\": \"\",\n \"countedAmount\": \"\"\n },\n {\n \"paymentMethodId\": \"\",\n \"countedAmount\": \"\"\n }\n ],\n \"withdrawals\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"RI\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"needsRecalculation\": \"\",\n \"zreportNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "f85f7679-9ac0-495e-8bdf-758a12bacccd", "name": "Calculated cash close preview (not persisted)", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes", "calculate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"closeAt\": \"\",\n \"warehouseId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"closeType\": \"I\",\n \"open\": \"\",\n \"changeKeptInRegister\": \"\",\n \"lines\": [\n {\n \"paymentMethodId\": \"\",\n \"countedAmount\": \"\"\n },\n {\n \"paymentMethodId\": \"\",\n \"countedAmount\": \"\"\n }\n ],\n \"withdrawals\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"RI\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"needsRecalculation\": \"\",\n \"zreportNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"closeAt\": \"\",\n \"warehouseId\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"closeType\": \"N\",\n \"open\": \"\",\n \"periodStartAt\": \"\",\n \"periodEndAt\": \"\",\n \"incomeAmount\": \"\",\n \"outgoingAmount\": \"\",\n \"calculatedAmount\": \"\",\n \"countedAmount\": \"\",\n \"depositAmount\": \"\",\n \"previousCashBalance\": \"\",\n \"cashBalance\": \"\",\n \"changeKeptInRegister\": \"\",\n \"vouchersIssuedAmount\": \"\",\n \"finalBalance\": \"\",\n \"warehouseName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"withdrawalJournalEntryId\": \"\",\n \"lines\": [\n {\n \"id\": \"\",\n \"cashCloseId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentKind\": \"D\",\n \"incomeAmount\": \"\",\n \"outgoingAmount\": \"\",\n \"calculatedAmount\": \"\",\n \"countedAmount\": \"\"\n },\n {\n \"id\": \"\",\n \"cashCloseId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentKind\": \"D\",\n \"incomeAmount\": \"\",\n \"outgoingAmount\": \"\",\n \"calculatedAmount\": \"\",\n \"countedAmount\": \"\"\n }\n ],\n \"withdrawals\": [\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"MC\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n },\n {\n \"amount\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"code\": \"\",\n \"transactionId\": \"\",\n \"externalRef\": \"\",\n \"uuid\": \"\",\n \"transactionKind\": \"CP\",\n \"lifecycleStatus\": \"\",\n \"issued\": \"\",\n \"closed\": \"\",\n \"validated\": \"\",\n \"amountTendered\": \"\",\n \"changeGiven\": \"\",\n \"amountSystem\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"currencyCodeSystem\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"withdrawalDate\": \"\",\n \"accountingDate\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"agreementCounterpartyId\": \"\",\n \"agreementCounterpartyName\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentAccountId\": \"\",\n \"paymentAccountName\": \"\",\n \"counterpartyAccountId\": \"\",\n \"counterpartyAccountName\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"claimId\": \"\",\n \"cashRegisterId\": \"\",\n \"journalEntryId\": \"\",\n \"voucherJournalEntryId\": \"\",\n \"accountingLedgerNumber\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardPosPayment\": \"\",\n \"cardPosActive\": \"\",\n \"cardPosType\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardTypeName\": \"\",\n \"cardAcquirerNetwork\": \"\",\n \"cardAcquirerName\": \"\",\n \"cardGroupName\": \"\",\n \"cardholderName\": \"\",\n \"cardMaskedNumber\": \"\",\n \"cardExpiryDate\": \"\",\n \"cardAuthorizationCode\": \"\",\n \"cardReferenceNumber\": \"\",\n \"cardBatch\": \"\",\n \"cardPaymentDate\": \"\",\n \"cardTerminalId\": \"\",\n \"cardMerchantId\": \"\",\n \"cardReadMode\": \"\",\n \"cardOttCode\": \"\",\n \"cardPayClub\": \"\",\n \"cardCreditType\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"cardInterestAmount\": \"\",\n \"paymentMethodTaxPct\": \"\",\n \"paymentMethodTaxAmount\": \"\",\n \"zeroRatedTaxBase\": \"\",\n \"taxableBase\": \"\",\n \"vatAmount\": \"\",\n \"cancelledPaymentId\": \"\",\n \"substitutePaymentId\": \"\",\n \"previousOutstandingAmount\": \"\",\n \"outstandingAmount\": \"\",\n \"partialPaymentSequence\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"sourceSystem\": \"\",\n \"sapCode\": \"\",\n \"lockType\": \"\",\n \"description\": \"\",\n \"attachmentId\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\",\n \"zreportNumber\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "76ba3fb1-d106-46ab-a2f9-8e4ca778da8e", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes", "calculate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"closeAt\": \"\",\n \"warehouseId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"closeType\": \"I\",\n \"open\": \"\",\n \"changeKeptInRegister\": \"\",\n \"lines\": [\n {\n \"paymentMethodId\": \"\",\n \"countedAmount\": \"\"\n },\n {\n \"paymentMethodId\": \"\",\n \"countedAmount\": \"\"\n }\n ],\n \"withdrawals\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"RI\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"needsRecalculation\": \"\",\n \"zreportNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "194fb99a-4971-49cd-87a7-bc93daabcce0", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes", "calculate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"closeAt\": \"\",\n \"warehouseId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"closeType\": \"I\",\n \"open\": \"\",\n \"changeKeptInRegister\": \"\",\n \"lines\": [\n {\n \"paymentMethodId\": \"\",\n \"countedAmount\": \"\"\n },\n {\n \"paymentMethodId\": \"\",\n \"countedAmount\": \"\"\n }\n ],\n \"withdrawals\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"RI\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"needsRecalculation\": \"\",\n \"zreportNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c26c1a96-ed93-4e61-b305-cad3981f4c09", "name": "Authenticated user is missing the `CREAR_CAJAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes", "calculate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"closeAt\": \"\",\n \"warehouseId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"closeType\": \"I\",\n \"open\": \"\",\n \"changeKeptInRegister\": \"\",\n \"lines\": [\n {\n \"paymentMethodId\": \"\",\n \"countedAmount\": \"\"\n },\n {\n \"paymentMethodId\": \"\",\n \"countedAmount\": \"\"\n }\n ],\n \"withdrawals\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"RI\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"needsRecalculation\": \"\",\n \"zreportNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c7b9117c-a79f-4392-a3e0-3a1601631039", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "cash-closes", "calculate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"closeAt\": \"\",\n \"warehouseId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"draft\": \"\",\n \"closeType\": \"I\",\n \"open\": \"\",\n \"changeKeptInRegister\": \"\",\n \"lines\": [\n {\n \"paymentMethodId\": \"\",\n \"countedAmount\": \"\"\n },\n {\n \"paymentMethodId\": \"\",\n \"countedAmount\": \"\"\n }\n ],\n \"withdrawals\": [\n {\n \"amount\": \"\",\n \"transactionKind\": \"RI\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n },\n {\n \"amount\": \"\",\n \"transactionKind\": \"C\",\n \"amountTendered\": \"\",\n \"exchangeRate\": \"\",\n \"currencyCode\": \"\",\n \"paymentDate\": \"\",\n \"dueDate\": \"\",\n \"counterpartyId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentAccountId\": \"\",\n \"counterpartyAccountId\": \"\",\n \"invoiceId\": \"\",\n \"deliveryNoteId\": \"\",\n \"orderId\": \"\",\n \"quoteId\": \"\",\n \"installmentId\": \"\",\n \"discountVoucherId\": \"\",\n \"linkedToAccounting\": \"\",\n \"cardType\": \"\",\n \"cardTypeId\": \"\",\n \"cardDeferredCode\": \"\",\n \"cardDeferredTerm\": \"\",\n \"cardGracePeriodMonths\": \"\",\n \"warehouseId\": \"\",\n \"description\": \"\",\n \"attachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"notes\": \"\"\n }\n ],\n \"needsRecalculation\": \"\",\n \"zreportNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "card-types", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "1170e4a0-4e1f-4c37-bffa-87e647206fb3", "name": "Get card type by ID", "request": { "name": "Get card type by ID", "description": { "content": "Returns a single card type by its primary key.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "card-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Card type ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "1344d97a-1b86-491d-add6-8127b0782ce8", "name": "Card type found", "originalRequest": { "url": { "path": [ "api", "v2", "card-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Card type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"creditAccount\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ecb35c48-497c-4ed2-b1d9-78b67c0b40a0", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "card-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Card type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5baa1acb-24cc-4c64-b139-cdcab56586a6", "name": "Authenticated user is missing the `VER_TIPOSTARJETAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "card-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Card type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "be706261-be4a-471d-8ce9-4ea10391fcb8", "name": "Card type not found", "originalRequest": { "url": { "path": [ "api", "v2", "card-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Card type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "207d703e-b05a-43ae-8d8c-f832400f6ffd", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "card-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Card type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "61050528-f227-46a5-a0c1-59a3052e6063", "name": "Update card type", "request": { "name": "Update card type", "description": { "content": "Full replacement of an existing card type.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "card-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Card type ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"creditAccount\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "c774de5e-4081-4824-8df0-74657bb55aa0", "name": "Card type updated", "originalRequest": { "url": { "path": [ "api", "v2", "card-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Card type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"creditAccount\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"creditAccount\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "96484b01-c060-41c0-ab67-8bed9cbd2bdc", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "card-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Card type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"creditAccount\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "85fb5565-9a46-4b50-8970-9f44da92ab42", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "card-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Card type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"creditAccount\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d8ecdaec-f235-4288-9ca6-11d6b3169829", "name": "Authenticated user is missing the `EDITAR_TIPOSTARJETAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "card-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Card type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"creditAccount\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "286d5737-5f3b-4431-a08c-6983dc6e9141", "name": "Card type not found", "originalRequest": { "url": { "path": [ "api", "v2", "card-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Card type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"creditAccount\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "439c2329-559a-4d8b-b24f-d34a199d2359", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "card-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Card type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"creditAccount\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "85bfb44d-ba18-4230-a14e-078975f1dd99", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "card-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Card type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"creditAccount\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7013fd3c-ca1c-434c-a528-cb3a47ffbd84", "name": "Delete card type", "request": { "name": "Delete card type", "description": { "content": "Deletes a card type.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "card-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Card type ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "d3462121-4f21-46d2-8b56-f028fa34a609", "name": "Card type deleted", "originalRequest": { "url": { "path": [ "api", "v2", "card-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Card type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d0032b78-2c33-4589-b2f9-35770e1e0726", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "card-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Card type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d85528d5-5bfe-4a61-bed0-4f807cd3b48c", "name": "Authenticated user is missing the `BORRAR_TIPOSTARJETAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "card-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Card type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "08c82330-2f0b-468d-b4ec-250b094b2560", "name": "Card type not found", "originalRequest": { "url": { "path": [ "api", "v2", "card-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Card type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "80671178-17f0-421c-be4e-d457a577e5d2", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "card-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Card type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2c78de43-6daf-4731-8d47-07355d8b16a1", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "card-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Card type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f80ee76d-1ee9-466b-9acb-005f05db8265", "name": "Merge-patch card type", "request": { "name": "Merge-patch card type", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "card-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Card type ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "2e86514e-cea3-4c6d-a0eb-42d2ca0b417c", "name": "Card type patched", "originalRequest": { "url": { "path": [ "api", "v2", "card-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Card type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"creditAccount\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "542fa91f-4419-411e-be7f-880c9bd8ebf3", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "card-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Card type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e6b48c58-1829-4eb4-9d0f-51a747bdf71a", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "card-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Card type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "398075a7-bd35-45e8-a463-22a4edc2a22d", "name": "Authenticated user is missing the `EDITAR_TIPOSTARJETAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "card-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Card type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d5104b9d-c9fc-455d-8ef3-9c65d3318f25", "name": "Card type not found", "originalRequest": { "url": { "path": [ "api", "v2", "card-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Card type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "07266993-c548-45c0-aa73-66690e6566c3", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "card-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Card type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cda0a533-2839-42d1-8505-9050be6b489a", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "card-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Card type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "b98263b1-d06d-456f-bc45-9cc476193c02", "name": "List card types", "request": { "name": "List card types", "description": { "content": "Returns a paginated list of card types with envelope `{data, totalCount, skip, limit, hasMore}`. Supports optional RSQL `filter`, `sort` (default `lastModifiedAt:desc`), `skip`/`limit` pagination and `modifiedAfter`/`modifiedBefore` bookends.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "card-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "dc8cbae3-5afe-41f6-bcd7-3d44ec7c52ed", "name": "Page of card types", "originalRequest": { "url": { "path": [ "api", "v2", "card-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5b451994-ff5c-43d4-92fa-95769d5a7b84", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "card-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f6480401-d60b-447c-8285-0c56000a62fe", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "card-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0ed58d07-c4c1-4a38-8fa1-0bb3937227d1", "name": "Authenticated user is missing the `VER_TIPOSTARJETAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "card-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5560f65a-2144-4cd1-abb8-ceccfe9f6449", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "card-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4b05b274-00da-4e99-a1e3-05c1a965dac4", "name": "Create card type", "request": { "name": "Create card type", "description": { "content": "Creates a new card type. Business logic runs in the legacy WAR. `code` is optional: when omitted the WAR assigns the next sequential company-scoped code (same rule as `POST /card-types/new`).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "card-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"creditAccount\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "c06910c8-e683-4ed2-adfe-bfce75653da6", "name": "Card type created", "originalRequest": { "url": { "path": [ "api", "v2", "card-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"creditAccount\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"creditAccount\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "22662cbd-1ebe-497a-9524-61f350c0e024", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "card-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"creditAccount\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "90d1a0b1-cd75-4c6e-a97e-2493df7fc0ad", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "card-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"creditAccount\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2be246c1-ac52-434a-88a1-c7697f6202f4", "name": "Authenticated user is missing the `CREAR_TIPOSTARJETAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "card-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"creditAccount\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1ddbf407-786a-41fd-ae67-e442f6bd141d", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "card-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"creditAccount\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5269d910-c84f-4e2c-b794-65a4b59252a3", "name": "Bulk delete card types", "request": { "name": "Bulk delete card types", "description": { "content": "Removes every id in `ids` as a single all-or-nothing transaction.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "card-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "c43e2f86-9518-413d-b397-aafe46e4127f", "name": "All entities deleted", "originalRequest": { "url": { "path": [ "api", "v2", "card-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"deleted\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e4d487df-a72a-425a-badf-260f2f77356b", "name": "Empty `ids` or unknown id", "originalRequest": { "url": { "path": [ "api", "v2", "card-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2121ce92-f261-4969-a752-583e27e48282", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "card-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c79ce945-c4ca-4b14-a004-d77da25a68ef", "name": "Authenticated user is missing the `BORRAR_TIPOSTARJETAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "card-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b5fad2f0-453d-494c-b085-7f2a903a4102", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "card-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1c3a6744-481e-4f34-a3d3-2542a5c8ed2c", "name": "Bulk patch card types", "request": { "name": "Bulk patch card types", "description": { "content": "Applies the same `patch` to every id in `ids` as a single all-or-nothing transaction. Editable fields: `enabled`.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "card-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"patch\": {\n \"key_0\": \"string\",\n \"key_1\": 4074,\n \"key_2\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "56788169-ce21-42d7-8ccb-cb82706d6aa2", "name": "All entities updated", "originalRequest": { "url": { "path": [ "api", "v2", "card-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"patch\": {\n \"key_0\": \"string\",\n \"key_1\": 4074,\n \"key_2\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"updated\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fde7e16b-8d3b-44be-9887-592656b47ab8", "name": "Empty `ids`/`patch`, malformed payload or non-whitelisted field", "originalRequest": { "url": { "path": [ "api", "v2", "card-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"patch\": {\n \"key_0\": \"string\",\n \"key_1\": 4074,\n \"key_2\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f8c214d5-f0b5-4347-92cf-3550d0af28da", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "card-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"patch\": {\n \"key_0\": \"string\",\n \"key_1\": 4074,\n \"key_2\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bff77962-141e-49a8-8e72-694c9ecbde99", "name": "Authenticated user is missing the `EDITAR_TIPOSTARJETAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "card-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"patch\": {\n \"key_0\": \"string\",\n \"key_1\": 4074,\n \"key_2\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a7ff7b1b-e244-4861-ae76-8f48340a5bd5", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "card-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"patch\": {\n \"key_0\": \"string\",\n \"key_1\": 4074,\n \"key_2\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "new", "description": "", "item": [ { "id": "d1633164-53b4-4b19-9146-6b8190bb8aa6", "name": "Prototype card type for a creation form", "request": { "name": "Prototype card type for a creation form", "description": { "content": "Returns a non-persisted card type pre-populated with backend defaults (current company, next sequential `code`, `enabled=true`). Optional JSON hints: `companyId`, `copyFromId`. Call `POST /api/v2/card-types` to persist.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "card-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "efb22564-8e98-4738-b3f4-a216e3e2bc06", "name": "Card type prototype with defaults", "originalRequest": { "url": { "path": [ "api", "v2", "card-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"creditAccount\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9cff0673-8d59-408d-8218-0ff30905e5c5", "name": "Invalid prepare-create hints", "originalRequest": { "url": { "path": [ "api", "v2", "card-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "465ef5e8-1ddf-4ba8-9d05-ac87b69a760b", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "card-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0ade3606-c123-4628-a5fc-bbe51a50bb43", "name": "Authenticated user is missing the `CREAR_TIPOSTARJETAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "card-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ea0d32f7-e6d7-4fdf-abf8-698a331ae42c", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "card-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "cancellation-causes", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "2a34ef6b-06fe-4504-aed0-e80d7eedb2a4", "name": "Get cancellation cause by ID", "request": { "name": "Get cancellation cause by ID", "description": { "content": "Returns a single cancellation cause by its primary key.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "cancellation-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Cancellation cause ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "41039209-8036-422e-8765-1845f7f383c2", "name": "Cancellation cause found", "originalRequest": { "url": { "path": [ "api", "v2", "cancellation-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cancellation cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"abbreviation\": \"\",\n \"cancellationRecipientType\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "93cff8b9-7b1e-4cc8-b813-3e416d619c4c", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "cancellation-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cancellation cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "25a4297a-e273-452e-b37f-3b64fb33e4e0", "name": "Authenticated user is missing the `VER_CAUSAANULACION` permission", "originalRequest": { "url": { "path": [ "api", "v2", "cancellation-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cancellation cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "af2062f0-f8cf-4f85-9da1-87524c1fed10", "name": "Cancellation cause not found", "originalRequest": { "url": { "path": [ "api", "v2", "cancellation-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cancellation cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2dead883-6ce8-43cf-bf0f-05e26ee5ab46", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "cancellation-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cancellation cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dd40c6cc-4330-467d-8743-e7a3d61d8be1", "name": "Update cancellation cause", "request": { "name": "Update cancellation cause", "description": { "content": "Full replacement of an existing cancellation cause. Send the `If-Match` header for optimistic concurrency (accepted but ignored ÔÇö not versioned).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "cancellation-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Cancellation cause ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"abbreviation\": \"\",\n \"cancellationRecipientType\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "e037978d-ab3f-428e-84fc-06c7dc3fdf22", "name": "Cancellation cause updated", "originalRequest": { "url": { "path": [ "api", "v2", "cancellation-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cancellation cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"abbreviation\": \"\",\n \"cancellationRecipientType\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"abbreviation\": \"\",\n \"cancellationRecipientType\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6161d4ab-aa81-496e-b4d9-e46059399e63", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "cancellation-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cancellation cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"abbreviation\": \"\",\n \"cancellationRecipientType\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e9594be2-6918-40ec-afe3-532e5db00d16", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "cancellation-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cancellation cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"abbreviation\": \"\",\n \"cancellationRecipientType\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9d057232-1fb8-4b36-beb2-d6d324a994cc", "name": "Authenticated user is missing the `EDITAR_CAUSAANULACION` permission", "originalRequest": { "url": { "path": [ "api", "v2", "cancellation-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cancellation cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"abbreviation\": \"\",\n \"cancellationRecipientType\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8a6db606-94a9-4cf6-b8a5-2ac8803cb6fd", "name": "Cancellation cause not found", "originalRequest": { "url": { "path": [ "api", "v2", "cancellation-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cancellation cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"abbreviation\": \"\",\n \"cancellationRecipientType\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3aa6c9ce-0211-4c21-b712-37837ccaf1f3", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "cancellation-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cancellation cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"abbreviation\": \"\",\n \"cancellationRecipientType\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "051733d5-0bf1-40be-bd60-744c361f1acf", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "cancellation-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cancellation cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"abbreviation\": \"\",\n \"cancellationRecipientType\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "529ce117-2453-4f38-8363-3525c0f631a3", "name": "Delete cancellation cause", "request": { "name": "Delete cancellation cause", "description": { "content": "Deletes a cancellation cause. Send the `If-Match` header with the current ETag (accepted but ignored ÔÇö not versioned).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "cancellation-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Cancellation cause ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "08c89d2b-bd50-4bfd-875e-e29a8ff8ff77", "name": "Cancellation cause deleted", "originalRequest": { "url": { "path": [ "api", "v2", "cancellation-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cancellation cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "565f276f-b9cd-4cfb-8a43-ccecdea342f2", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "cancellation-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cancellation cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "76976352-90db-4b1b-b54c-291005074da1", "name": "Authenticated user is missing the `BORRAR_CAUSAANULACION` permission", "originalRequest": { "url": { "path": [ "api", "v2", "cancellation-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cancellation cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "dba8edac-5c12-41ef-b08e-8faa6bfb8f3c", "name": "Cancellation cause not found", "originalRequest": { "url": { "path": [ "api", "v2", "cancellation-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cancellation cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f7b8fce1-be45-47f3-8eb1-3c17446ce9e6", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "cancellation-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cancellation cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8c0c830b-e101-4e73-b3af-cda7f91163a7", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "cancellation-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cancellation cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "861fb807-c295-4bec-bb4e-9701e6a6dd67", "name": "Merge-patch cancellation cause", "request": { "name": "Merge-patch cancellation cause", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "cancellation-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Cancellation cause ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "24ef1e51-092f-4f6c-953d-61fe90ab48c7", "name": "Cancellation cause patched", "originalRequest": { "url": { "path": [ "api", "v2", "cancellation-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cancellation cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"abbreviation\": \"\",\n \"cancellationRecipientType\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "def3ffde-e14e-4dbb-a7af-e5019e1d6be2", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details. Also returned for malformed merge-patch payloads.", "originalRequest": { "url": { "path": [ "api", "v2", "cancellation-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cancellation cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "538a1c5d-f562-43ee-aa5b-c49797372d01", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "cancellation-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cancellation cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d0a4b1c6-e6d6-457c-b53b-13b17a356474", "name": "Authenticated user is missing the `EDITAR_CAUSAANULACION` permission", "originalRequest": { "url": { "path": [ "api", "v2", "cancellation-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cancellation cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8bcbc024-a7af-430f-87f8-8b331a092489", "name": "Cancellation cause not found", "originalRequest": { "url": { "path": [ "api", "v2", "cancellation-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cancellation cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ed96de11-2e1c-43bb-af63-9a390268d814", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "cancellation-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cancellation cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3b8a6eb7-d016-4bd5-9449-16590017d1a7", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "cancellation-causes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cancellation cause ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "0cd63ddd-0f1b-4635-a7c2-d2f4e60d9a85", "name": "List cancellation causes", "request": { "name": "List cancellation causes", "description": { "content": "Returns a paginated list of cancellation causes with envelope `{data, totalCount, skip, limit, hasMore}`. Supports optional RSQL `filter`, `sort` (default `name:asc`), `skip`/`limit` pagination and `modifiedAfter`/`modifiedBefore` bookends.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "cancellation-causes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "08455554-9ade-48fa-b1aa-d01a7c6f8092", "name": "Page of cancellation causes", "originalRequest": { "url": { "path": [ "api", "v2", "cancellation-causes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "241f6d18-b3d8-4a87-8876-0d6ac8f4cced", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "cancellation-causes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9d1035f0-be0b-487c-a5f4-29d3e2bf6dcd", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "cancellation-causes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8ea3d345-8182-4c21-87e2-e28057a94057", "name": "Authenticated user is missing the `VER_CAUSAANULACION` permission", "originalRequest": { "url": { "path": [ "api", "v2", "cancellation-causes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d38f2747-4a94-4db8-a817-a3194a4cd68f", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "cancellation-causes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "739e70c5-e31e-40a0-a960-e2beca70393f", "name": "Create cancellation cause", "request": { "name": "Create cancellation cause", "description": { "content": "Creates a new cancellation cause. Business logic runs in the legacy WAR via the internal commands gateway.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "cancellation-causes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"abbreviation\": \"\",\n \"cancellationRecipientType\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "979d7dd1-163d-48d8-92fc-106c1ecac6e6", "name": "Cancellation cause created", "originalRequest": { "url": { "path": [ "api", "v2", "cancellation-causes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"abbreviation\": \"\",\n \"cancellationRecipientType\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"abbreviation\": \"\",\n \"cancellationRecipientType\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1b1cc0d0-49fb-4166-b6cb-293fd06677bd", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "cancellation-causes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"abbreviation\": \"\",\n \"cancellationRecipientType\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "eac244e9-3667-4787-bb40-fe72b9b7d596", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "cancellation-causes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"abbreviation\": \"\",\n \"cancellationRecipientType\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "28ca5c73-b24c-49a9-a056-beca7b644e1f", "name": "Authenticated user is missing the `CREAR_CAUSAANULACION` permission", "originalRequest": { "url": { "path": [ "api", "v2", "cancellation-causes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"abbreviation\": \"\",\n \"cancellationRecipientType\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "94ac6a22-a679-480a-9edf-99dd767087a5", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "cancellation-causes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"abbreviation\": \"\",\n \"cancellationRecipientType\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "new", "description": "", "item": [ { "id": "390058c4-8345-4631-9880-28f18e55e425", "name": "Prototype cancellation cause for a creation form", "request": { "name": "Prototype cancellation cause for a creation form", "description": { "content": "Returns a non-persisted cancellation cause pre-populated with backend defaults (`enabled=true`, current company, next `code`). Optional JSON hints: `companyId`, `warehouseId`, `copyFromId`. The response has no `id`, `version` or audit fields; call `POST /api/v2/cancellation-causes` afterwards to persist.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "cancellation-causes", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "0a71e095-67e3-4a45-9fd6-6698dcaee3bc", "name": "Cancellation cause prototype with defaults", "originalRequest": { "url": { "path": [ "api", "v2", "cancellation-causes", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"abbreviation\": \"\",\n \"cancellationRecipientType\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "eb2671c4-b3cf-4927-bb17-72c430c65801", "name": "Invalid prepare-create hints", "originalRequest": { "url": { "path": [ "api", "v2", "cancellation-causes", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cc60f494-df68-4757-a5c7-d1a443bd9acd", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "cancellation-causes", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "116d6a43-12e9-464a-90dd-cf9a33a7b2ca", "name": "Authenticated user is missing the `CREAR_CAUSAANULACION` permission", "originalRequest": { "url": { "path": [ "api", "v2", "cancellation-causes", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "dc8e0881-2283-40d0-99b9-37bcbd09fcb4", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "cancellation-causes", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "campaigns", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "29789406-a22a-4c75-b65a-4e944a1621dd", "name": "Get campaign by ID", "request": { "name": "Get campaign by ID", "description": { "content": "Returns a single campaign by its primary key. The response carries a strong `ETag` header with the current version.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Campaign ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "049644c5-8428-42b1-8f29-4bdd71f2fb78", "name": "Campaign found", "originalRequest": { "url": { "path": [ "api", "v2", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Campaign ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6efe3693-95c9-4eb3-a7b2-0a15b454b58c", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Campaign ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ad840855-29ec-4b53-be14-7488a3e3908c", "name": "Authenticated user is missing the `VER_CAMPANIAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Campaign ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "29f82d50-7098-414b-b40d-a79e6f53db60", "name": "Campaign not found", "originalRequest": { "url": { "path": [ "api", "v2", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Campaign ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "482926fd-60a3-4cc2-955f-0919d47efd00", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Campaign ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "69d86c92-e446-4f59-a3bc-08eaf9219fe4", "name": "Update campaign", "request": { "name": "Update campaign", "description": { "content": "Full replacement of an existing campaign. Send the `If-Match` header with the current ETag for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Campaign ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "5f745f9d-8bce-40e7-8d98-5a372b2255b9", "name": "Campaign updated", "originalRequest": { "url": { "path": [ "api", "v2", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Campaign ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b4eca6f5-efc2-4e80-bc4c-dc1086682de0", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Campaign ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b6c7207b-e23b-4f0a-8bde-1780d381369b", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Campaign ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a78721ed-f233-481d-8c9c-df2ab6ad8882", "name": "Authenticated user is missing the `EDITAR_CAMPANIAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Campaign ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cb7a2d31-5acd-46c7-8d7b-bf07dc0f8c10", "name": "Campaign not found", "originalRequest": { "url": { "path": [ "api", "v2", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Campaign ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bacf7dbf-cda4-42cb-95de-7b700f6debc5", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Campaign ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f531e548-920a-4492-85c6-c348f83c486f", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Campaign ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cf7a53ac-7db0-47ac-b926-6fc3260fa89b", "name": "Delete campaign", "request": { "name": "Delete campaign", "description": { "content": "Deletes a campaign. Send the `If-Match` header with the current ETag for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Campaign ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "f08a6076-853e-4c5b-a024-9ec5b26c25ec", "name": "Campaign deleted", "originalRequest": { "url": { "path": [ "api", "v2", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Campaign ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "45bafcaa-1868-48fe-9187-892880ff8cf1", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Campaign ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "79a46a03-d4f9-471a-ac6a-1a78696f2558", "name": "Authenticated user is missing the `BORRAR_CAMPANIAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Campaign ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c0281c84-d873-4344-a25c-5a6fb97944aa", "name": "Campaign not found", "originalRequest": { "url": { "path": [ "api", "v2", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Campaign ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "110b291e-a8a9-4745-b5a2-1815899479c3", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Campaign ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "71447e08-1f73-4015-ad66-8e9fcb86c0fc", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Campaign ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "32e59fbb-a61b-4b31-bb95-c84baa1d3ba3", "name": "Merge-patch campaign", "request": { "name": "Merge-patch campaign", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Campaign ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "a305b978-5a70-4a84-ae9b-dd052863bce2", "name": "Campaign patched", "originalRequest": { "url": { "path": [ "api", "v2", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Campaign ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9418d3e0-a9a9-454e-9535-15f4bc00a4eb", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details. Also returned for malformed merge-patch payloads.", "originalRequest": { "url": { "path": [ "api", "v2", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Campaign ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "dcf1479b-858a-4781-a0a2-cf56b25e7211", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Campaign ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "84c90466-a58a-48dc-ac8a-8ea4db9a3b95", "name": "Authenticated user is missing the `EDITAR_CAMPANIAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Campaign ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "89128794-c815-4ea6-a9ca-7e37c1332354", "name": "Campaign not found", "originalRequest": { "url": { "path": [ "api", "v2", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Campaign ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ee8cb5f0-41b9-4841-b71d-814acc8e3feb", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Campaign ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fbd7fe00-0b33-4cfa-a1dc-53d63b9c68c1", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Campaign ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "a9d95814-11e9-4be3-ba92-19b5f7322896", "name": "List campaigns", "request": { "name": "List campaigns", "description": { "content": "Returns a paginated list of campaigns with envelope `{data, totalCount, skip, limit, hasMore}`. Default sort is `startDate:desc` so most recent campaigns appear first. Limit is capped at 200; skip is clamped to >= 0.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "startDate:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "0f4386f5-74d0-4dcf-bd46-4c035c8cccc7", "name": "Page of campaigns", "originalRequest": { "url": { "path": [ "api", "v2", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "startDate:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "50b853bb-15f4-43ed-91a4-cae437948db6", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "startDate:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3f586024-d338-4ada-b71c-4402fac5cce8", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "startDate:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "08df3fb3-d8e2-448a-b27b-cf2c03e369ef", "name": "Authenticated user is missing the `VER_CAMPANIAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "startDate:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "34fba328-cccb-45c7-bb52-b8bfc9014c6e", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "startDate:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4cb0905d-b867-4ae9-86d8-3f330702ab5c", "name": "Create campaign", "request": { "name": "Create campaign", "description": { "content": "Creates a new campaign. Business logic runs in the legacy WAR via the internal commands gateway.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "8ae292ab-3c06-4fb8-8dd0-02d8b84f4c0a", "name": "Campaign created", "originalRequest": { "url": { "path": [ "api", "v2", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "613f18c8-7c8c-412a-88a1-0d072ffcb096", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8c019a9c-c965-4291-8c66-82ab6ac580bb", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7ff9a656-fcde-476a-836c-b9294514a1e1", "name": "Authenticated user is missing the `CREAR_CAMPANIAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2f06815a-ee45-4594-b6ea-852e77425ee3", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "new", "description": "", "item": [ { "id": "12d6e00e-1620-41df-9747-a5a935a6ab3d", "name": "Prototype campaign for a creation form", "request": { "name": "Prototype campaign for a creation form", "description": { "content": "Returns a non-persisted campaign pre-populated with backend defaults. Optional hints include `companyId` and `copyFromId`. The response has no `id`, `version` or audit fields; call `POST /api/v2/campaigns` afterwards to persist it.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "campaigns", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "3ed4be08-b222-42e0-896a-407292f8b079", "name": "Campaign prototype with defaults", "originalRequest": { "url": { "path": [ "api", "v2", "campaigns", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "87abcb27-dca6-432a-8967-4f0cc7f119d5", "name": "Invalid prepare-create hints", "originalRequest": { "url": { "path": [ "api", "v2", "campaigns", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bc303750-c81c-454a-adec-da8e1867fa19", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "campaigns", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3142b972-fac9-4ed2-ae03-e84e2a3b4564", "name": "Authenticated user is missing the `CREAR_CAMPANIAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "campaigns", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "447c704f-36df-4410-ba3e-8b0a2341a84a", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "campaigns", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "calendars", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "69f41fe2-5d81-4de6-a498-8b64595c1228", "name": "Get calendar by ID", "request": { "name": "Get calendar by ID", "description": { "content": "Returns a single calendar by its primary key. The response carries a strong `ETag` header with the current version.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "93dca31f-8023-410b-ba32-302f7718d0c7", "name": "Calendar found", "originalRequest": { "url": { "path": [ "api", "v2", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"widgetSlug\": \"\",\n \"widgetType\": \"default\",\n \"eventTitle\": \"\",\n \"color\": \"\",\n \"active\": \"\",\n \"enabled\": \"\",\n \"groupId\": \"\",\n \"groupName\": \"\",\n \"calendarType\": \"service_booking\",\n \"legacyCalendarType\": \"SERVICIO\",\n \"eventType\": \"RoundRobin_OptimizeForEqualDistribution\",\n \"teamMembers\": [\n {\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"custom\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"inbound_call\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n },\n {\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"booker\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n }\n ],\n \"employeeIds\": [\n \"\",\n \"\"\n ],\n \"slotDuration\": \"\",\n \"slotDurationUnit\": \"hours\",\n \"defaultDurationMinutes\": \"\",\n \"slotMinutes\": \"\",\n \"defaultView\": \"DIA\",\n \"timeUnit\": \"MINUTES\",\n \"predefinedSlots\": \"\",\n \"slotInterval\": \"\",\n \"slotIntervalUnit\": \"\",\n \"slotBuffer\": \"\",\n \"slotBufferUnit\": \"\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"\",\n \"appoinmentPerSlot\": \"\",\n \"appoinmentPerDay\": \"\",\n \"allowBookingAfter\": \"\",\n \"allowBookingAfterUnit\": \"\",\n \"allowBookingFor\": \"\",\n \"allowBookingForUnit\": \"\",\n \"openHours\": [\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n },\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n }\n ],\n \"availabilities\": [\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n },\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n }\n ],\n \"availabilityType\": \"\",\n \"openingTime\": \"\",\n \"closingTime\": \"\",\n \"enableRecurring\": \"\",\n \"recurring\": {\n \"freq\": \"WEEKLY\",\n \"count\": \"\",\n \"bookingOption\": \"book_next\",\n \"bookingOverlapDefaultStatus\": \"new\"\n },\n \"lookBusyConfig\": {\n \"enabled\": \"\",\n \"LookBusyPercentage\": \"\"\n },\n \"formId\": \"\",\n \"formSubmitType\": \"RedirectURL\",\n \"formSubmitRedirectUrl\": \"\",\n \"formSubmitThanksMessage\": \"\",\n \"autoConfirm\": \"\",\n \"allowReschedule\": \"\",\n \"allowCancellation\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "df393ed6-bdcb-4faa-9134-812c7a1c59e8", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "82f01fb5-0c79-4129-b674-a533ad7de1a2", "name": "Authenticated user is missing the `VER_CALENDARIOUI` permission", "originalRequest": { "url": { "path": [ "api", "v2", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ae7df36b-fb27-4cfe-93af-4b2687b68fe9", "name": "Calendar not found", "originalRequest": { "url": { "path": [ "api", "v2", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4cecec40-2f1c-4109-a84a-62c371e28742", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "224ac2d5-360a-438c-bab1-b84bb63af9ac", "name": "Update calendar", "request": { "name": "Update calendar", "description": { "content": "Full replacement of an existing calendar. Send the `If-Match` header with the current ETag for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"widgetSlug\": \"\",\n \"widgetType\": \"classic\",\n \"eventTitle\": \"\",\n \"color\": \"\",\n \"active\": \"\",\n \"enabled\": \"\",\n \"groupId\": \"\",\n \"calendarType\": \"event\",\n \"legacyCalendarType\": \"SERVICIO\",\n \"eventType\": \"RoundRobin_OptimizeForEqualDistribution\",\n \"teamMembers\": [\n {\n \"employeeId\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"zoom_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n },\n {\n \"employeeId\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"inbound_call\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n }\n ],\n \"employeeIds\": [\n \"\",\n \"\"\n ],\n \"slotDuration\": \"\",\n \"slotDurationUnit\": \"mins\",\n \"defaultDurationMinutes\": \"\",\n \"slotMinutes\": \"\",\n \"defaultView\": \"MES\",\n \"timeUnit\": \"MINUTES\",\n \"predefinedSlots\": \"\",\n \"slotInterval\": \"\",\n \"slotIntervalUnit\": \"\",\n \"slotBuffer\": \"\",\n \"slotBufferUnit\": \"\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"\",\n \"appoinmentPerSlot\": \"\",\n \"appoinmentPerDay\": \"\",\n \"allowBookingAfter\": \"\",\n \"allowBookingAfterUnit\": \"\",\n \"allowBookingFor\": \"\",\n \"allowBookingForUnit\": \"\",\n \"openHours\": [\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n },\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n }\n ],\n \"availabilities\": [\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n },\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n }\n ],\n \"availabilityType\": \"\",\n \"openingTime\": \"\",\n \"closingTime\": \"\",\n \"enableRecurring\": \"\",\n \"recurring\": {\n \"freq\": \"WEEKLY\",\n \"count\": \"\",\n \"bookingOption\": \"book_next\",\n \"bookingOverlapDefaultStatus\": \"new\"\n },\n \"lookBusyConfig\": {\n \"enabled\": \"\",\n \"LookBusyPercentage\": \"\"\n },\n \"formId\": \"\",\n \"formSubmitType\": \"ThankYouMessage\",\n \"formSubmitRedirectUrl\": \"\",\n \"formSubmitThanksMessage\": \"\",\n \"autoConfirm\": \"\",\n \"allowReschedule\": \"\",\n \"allowCancellation\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "f4e6c372-fb5e-415c-853f-e30feab45361", "name": "Calendar updated", "originalRequest": { "url": { "path": [ "api", "v2", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"widgetSlug\": \"\",\n \"widgetType\": \"classic\",\n \"eventTitle\": \"\",\n \"color\": \"\",\n \"active\": \"\",\n \"enabled\": \"\",\n \"groupId\": \"\",\n \"calendarType\": \"event\",\n \"legacyCalendarType\": \"SERVICIO\",\n \"eventType\": \"RoundRobin_OptimizeForEqualDistribution\",\n \"teamMembers\": [\n {\n \"employeeId\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"zoom_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n },\n {\n \"employeeId\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"inbound_call\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n }\n ],\n \"employeeIds\": [\n \"\",\n \"\"\n ],\n \"slotDuration\": \"\",\n \"slotDurationUnit\": \"mins\",\n \"defaultDurationMinutes\": \"\",\n \"slotMinutes\": \"\",\n \"defaultView\": \"MES\",\n \"timeUnit\": \"MINUTES\",\n \"predefinedSlots\": \"\",\n \"slotInterval\": \"\",\n \"slotIntervalUnit\": \"\",\n \"slotBuffer\": \"\",\n \"slotBufferUnit\": \"\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"\",\n \"appoinmentPerSlot\": \"\",\n \"appoinmentPerDay\": \"\",\n \"allowBookingAfter\": \"\",\n \"allowBookingAfterUnit\": \"\",\n \"allowBookingFor\": \"\",\n \"allowBookingForUnit\": \"\",\n \"openHours\": [\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n },\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n }\n ],\n \"availabilities\": [\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n },\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n }\n ],\n \"availabilityType\": \"\",\n \"openingTime\": \"\",\n \"closingTime\": \"\",\n \"enableRecurring\": \"\",\n \"recurring\": {\n \"freq\": \"WEEKLY\",\n \"count\": \"\",\n \"bookingOption\": \"book_next\",\n \"bookingOverlapDefaultStatus\": \"new\"\n },\n \"lookBusyConfig\": {\n \"enabled\": \"\",\n \"LookBusyPercentage\": \"\"\n },\n \"formId\": \"\",\n \"formSubmitType\": \"ThankYouMessage\",\n \"formSubmitRedirectUrl\": \"\",\n \"formSubmitThanksMessage\": \"\",\n \"autoConfirm\": \"\",\n \"allowReschedule\": \"\",\n \"allowCancellation\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"widgetSlug\": \"\",\n \"widgetType\": \"default\",\n \"eventTitle\": \"\",\n \"color\": \"\",\n \"active\": \"\",\n \"enabled\": \"\",\n \"groupId\": \"\",\n \"groupName\": \"\",\n \"calendarType\": \"service_booking\",\n \"legacyCalendarType\": \"SERVICIO\",\n \"eventType\": \"RoundRobin_OptimizeForEqualDistribution\",\n \"teamMembers\": [\n {\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"custom\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"inbound_call\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n },\n {\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"booker\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n }\n ],\n \"employeeIds\": [\n \"\",\n \"\"\n ],\n \"slotDuration\": \"\",\n \"slotDurationUnit\": \"hours\",\n \"defaultDurationMinutes\": \"\",\n \"slotMinutes\": \"\",\n \"defaultView\": \"DIA\",\n \"timeUnit\": \"MINUTES\",\n \"predefinedSlots\": \"\",\n \"slotInterval\": \"\",\n \"slotIntervalUnit\": \"\",\n \"slotBuffer\": \"\",\n \"slotBufferUnit\": \"\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"\",\n \"appoinmentPerSlot\": \"\",\n \"appoinmentPerDay\": \"\",\n \"allowBookingAfter\": \"\",\n \"allowBookingAfterUnit\": \"\",\n \"allowBookingFor\": \"\",\n \"allowBookingForUnit\": \"\",\n \"openHours\": [\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n },\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n }\n ],\n \"availabilities\": [\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n },\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n }\n ],\n \"availabilityType\": \"\",\n \"openingTime\": \"\",\n \"closingTime\": \"\",\n \"enableRecurring\": \"\",\n \"recurring\": {\n \"freq\": \"WEEKLY\",\n \"count\": \"\",\n \"bookingOption\": \"book_next\",\n \"bookingOverlapDefaultStatus\": \"new\"\n },\n \"lookBusyConfig\": {\n \"enabled\": \"\",\n \"LookBusyPercentage\": \"\"\n },\n \"formId\": \"\",\n \"formSubmitType\": \"RedirectURL\",\n \"formSubmitRedirectUrl\": \"\",\n \"formSubmitThanksMessage\": \"\",\n \"autoConfirm\": \"\",\n \"allowReschedule\": \"\",\n \"allowCancellation\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "81dfab39-6729-4853-b57c-65a80ef16006", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"widgetSlug\": \"\",\n \"widgetType\": \"classic\",\n \"eventTitle\": \"\",\n \"color\": \"\",\n \"active\": \"\",\n \"enabled\": \"\",\n \"groupId\": \"\",\n \"calendarType\": \"event\",\n \"legacyCalendarType\": \"SERVICIO\",\n \"eventType\": \"RoundRobin_OptimizeForEqualDistribution\",\n \"teamMembers\": [\n {\n \"employeeId\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"zoom_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n },\n {\n \"employeeId\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"inbound_call\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n }\n ],\n \"employeeIds\": [\n \"\",\n \"\"\n ],\n \"slotDuration\": \"\",\n \"slotDurationUnit\": \"mins\",\n \"defaultDurationMinutes\": \"\",\n \"slotMinutes\": \"\",\n \"defaultView\": \"MES\",\n \"timeUnit\": \"MINUTES\",\n \"predefinedSlots\": \"\",\n \"slotInterval\": \"\",\n \"slotIntervalUnit\": \"\",\n \"slotBuffer\": \"\",\n \"slotBufferUnit\": \"\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"\",\n \"appoinmentPerSlot\": \"\",\n \"appoinmentPerDay\": \"\",\n \"allowBookingAfter\": \"\",\n \"allowBookingAfterUnit\": \"\",\n \"allowBookingFor\": \"\",\n \"allowBookingForUnit\": \"\",\n \"openHours\": [\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n },\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n }\n ],\n \"availabilities\": [\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n },\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n }\n ],\n \"availabilityType\": \"\",\n \"openingTime\": \"\",\n \"closingTime\": \"\",\n \"enableRecurring\": \"\",\n \"recurring\": {\n \"freq\": \"WEEKLY\",\n \"count\": \"\",\n \"bookingOption\": \"book_next\",\n \"bookingOverlapDefaultStatus\": \"new\"\n },\n \"lookBusyConfig\": {\n \"enabled\": \"\",\n \"LookBusyPercentage\": \"\"\n },\n \"formId\": \"\",\n \"formSubmitType\": \"ThankYouMessage\",\n \"formSubmitRedirectUrl\": \"\",\n \"formSubmitThanksMessage\": \"\",\n \"autoConfirm\": \"\",\n \"allowReschedule\": \"\",\n \"allowCancellation\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "43eb3b33-9874-4d90-b517-e49375f5b42b", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"widgetSlug\": \"\",\n \"widgetType\": \"classic\",\n \"eventTitle\": \"\",\n \"color\": \"\",\n \"active\": \"\",\n \"enabled\": \"\",\n \"groupId\": \"\",\n \"calendarType\": \"event\",\n \"legacyCalendarType\": \"SERVICIO\",\n \"eventType\": \"RoundRobin_OptimizeForEqualDistribution\",\n \"teamMembers\": [\n {\n \"employeeId\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"zoom_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n },\n {\n \"employeeId\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"inbound_call\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n }\n ],\n \"employeeIds\": [\n \"\",\n \"\"\n ],\n \"slotDuration\": \"\",\n \"slotDurationUnit\": \"mins\",\n \"defaultDurationMinutes\": \"\",\n \"slotMinutes\": \"\",\n \"defaultView\": \"MES\",\n \"timeUnit\": \"MINUTES\",\n \"predefinedSlots\": \"\",\n \"slotInterval\": \"\",\n \"slotIntervalUnit\": \"\",\n \"slotBuffer\": \"\",\n \"slotBufferUnit\": \"\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"\",\n \"appoinmentPerSlot\": \"\",\n \"appoinmentPerDay\": \"\",\n \"allowBookingAfter\": \"\",\n \"allowBookingAfterUnit\": \"\",\n \"allowBookingFor\": \"\",\n \"allowBookingForUnit\": \"\",\n \"openHours\": [\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n },\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n }\n ],\n \"availabilities\": [\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n },\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n }\n ],\n \"availabilityType\": \"\",\n \"openingTime\": \"\",\n \"closingTime\": \"\",\n \"enableRecurring\": \"\",\n \"recurring\": {\n \"freq\": \"WEEKLY\",\n \"count\": \"\",\n \"bookingOption\": \"book_next\",\n \"bookingOverlapDefaultStatus\": \"new\"\n },\n \"lookBusyConfig\": {\n \"enabled\": \"\",\n \"LookBusyPercentage\": \"\"\n },\n \"formId\": \"\",\n \"formSubmitType\": \"ThankYouMessage\",\n \"formSubmitRedirectUrl\": \"\",\n \"formSubmitThanksMessage\": \"\",\n \"autoConfirm\": \"\",\n \"allowReschedule\": \"\",\n \"allowCancellation\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a37c5e24-cee1-466a-8944-1aa8a31459f8", "name": "Authenticated user is missing the `EDITAR_CALENDARIOUI` permission", "originalRequest": { "url": { "path": [ "api", "v2", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"widgetSlug\": \"\",\n \"widgetType\": \"classic\",\n \"eventTitle\": \"\",\n \"color\": \"\",\n \"active\": \"\",\n \"enabled\": \"\",\n \"groupId\": \"\",\n \"calendarType\": \"event\",\n \"legacyCalendarType\": \"SERVICIO\",\n \"eventType\": \"RoundRobin_OptimizeForEqualDistribution\",\n \"teamMembers\": [\n {\n \"employeeId\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"zoom_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n },\n {\n \"employeeId\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"inbound_call\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n }\n ],\n \"employeeIds\": [\n \"\",\n \"\"\n ],\n \"slotDuration\": \"\",\n \"slotDurationUnit\": \"mins\",\n \"defaultDurationMinutes\": \"\",\n \"slotMinutes\": \"\",\n \"defaultView\": \"MES\",\n \"timeUnit\": \"MINUTES\",\n \"predefinedSlots\": \"\",\n \"slotInterval\": \"\",\n \"slotIntervalUnit\": \"\",\n \"slotBuffer\": \"\",\n \"slotBufferUnit\": \"\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"\",\n \"appoinmentPerSlot\": \"\",\n \"appoinmentPerDay\": \"\",\n \"allowBookingAfter\": \"\",\n \"allowBookingAfterUnit\": \"\",\n \"allowBookingFor\": \"\",\n \"allowBookingForUnit\": \"\",\n \"openHours\": [\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n },\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n }\n ],\n \"availabilities\": [\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n },\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n }\n ],\n \"availabilityType\": \"\",\n \"openingTime\": \"\",\n \"closingTime\": \"\",\n \"enableRecurring\": \"\",\n \"recurring\": {\n \"freq\": \"WEEKLY\",\n \"count\": \"\",\n \"bookingOption\": \"book_next\",\n \"bookingOverlapDefaultStatus\": \"new\"\n },\n \"lookBusyConfig\": {\n \"enabled\": \"\",\n \"LookBusyPercentage\": \"\"\n },\n \"formId\": \"\",\n \"formSubmitType\": \"ThankYouMessage\",\n \"formSubmitRedirectUrl\": \"\",\n \"formSubmitThanksMessage\": \"\",\n \"autoConfirm\": \"\",\n \"allowReschedule\": \"\",\n \"allowCancellation\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b161e927-9bc6-4a24-8773-f7bb2e245ae8", "name": "Calendar not found", "originalRequest": { "url": { "path": [ "api", "v2", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"widgetSlug\": \"\",\n \"widgetType\": \"classic\",\n \"eventTitle\": \"\",\n \"color\": \"\",\n \"active\": \"\",\n \"enabled\": \"\",\n \"groupId\": \"\",\n \"calendarType\": \"event\",\n \"legacyCalendarType\": \"SERVICIO\",\n \"eventType\": \"RoundRobin_OptimizeForEqualDistribution\",\n \"teamMembers\": [\n {\n \"employeeId\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"zoom_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n },\n {\n \"employeeId\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"inbound_call\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n }\n ],\n \"employeeIds\": [\n \"\",\n \"\"\n ],\n \"slotDuration\": \"\",\n \"slotDurationUnit\": \"mins\",\n \"defaultDurationMinutes\": \"\",\n \"slotMinutes\": \"\",\n \"defaultView\": \"MES\",\n \"timeUnit\": \"MINUTES\",\n \"predefinedSlots\": \"\",\n \"slotInterval\": \"\",\n \"slotIntervalUnit\": \"\",\n \"slotBuffer\": \"\",\n \"slotBufferUnit\": \"\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"\",\n \"appoinmentPerSlot\": \"\",\n \"appoinmentPerDay\": \"\",\n \"allowBookingAfter\": \"\",\n \"allowBookingAfterUnit\": \"\",\n \"allowBookingFor\": \"\",\n \"allowBookingForUnit\": \"\",\n \"openHours\": [\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n },\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n }\n ],\n \"availabilities\": [\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n },\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n }\n ],\n \"availabilityType\": \"\",\n \"openingTime\": \"\",\n \"closingTime\": \"\",\n \"enableRecurring\": \"\",\n \"recurring\": {\n \"freq\": \"WEEKLY\",\n \"count\": \"\",\n \"bookingOption\": \"book_next\",\n \"bookingOverlapDefaultStatus\": \"new\"\n },\n \"lookBusyConfig\": {\n \"enabled\": \"\",\n \"LookBusyPercentage\": \"\"\n },\n \"formId\": \"\",\n \"formSubmitType\": \"ThankYouMessage\",\n \"formSubmitRedirectUrl\": \"\",\n \"formSubmitThanksMessage\": \"\",\n \"autoConfirm\": \"\",\n \"allowReschedule\": \"\",\n \"allowCancellation\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8883f745-b5ab-4bc1-87db-fe521b0ff940", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"widgetSlug\": \"\",\n \"widgetType\": \"classic\",\n \"eventTitle\": \"\",\n \"color\": \"\",\n \"active\": \"\",\n \"enabled\": \"\",\n \"groupId\": \"\",\n \"calendarType\": \"event\",\n \"legacyCalendarType\": \"SERVICIO\",\n \"eventType\": \"RoundRobin_OptimizeForEqualDistribution\",\n \"teamMembers\": [\n {\n \"employeeId\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"zoom_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n },\n {\n \"employeeId\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"inbound_call\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n }\n ],\n \"employeeIds\": [\n \"\",\n \"\"\n ],\n \"slotDuration\": \"\",\n \"slotDurationUnit\": \"mins\",\n \"defaultDurationMinutes\": \"\",\n \"slotMinutes\": \"\",\n \"defaultView\": \"MES\",\n \"timeUnit\": \"MINUTES\",\n \"predefinedSlots\": \"\",\n \"slotInterval\": \"\",\n \"slotIntervalUnit\": \"\",\n \"slotBuffer\": \"\",\n \"slotBufferUnit\": \"\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"\",\n \"appoinmentPerSlot\": \"\",\n \"appoinmentPerDay\": \"\",\n \"allowBookingAfter\": \"\",\n \"allowBookingAfterUnit\": \"\",\n \"allowBookingFor\": \"\",\n \"allowBookingForUnit\": \"\",\n \"openHours\": [\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n },\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n }\n ],\n \"availabilities\": [\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n },\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n }\n ],\n \"availabilityType\": \"\",\n \"openingTime\": \"\",\n \"closingTime\": \"\",\n \"enableRecurring\": \"\",\n \"recurring\": {\n \"freq\": \"WEEKLY\",\n \"count\": \"\",\n \"bookingOption\": \"book_next\",\n \"bookingOverlapDefaultStatus\": \"new\"\n },\n \"lookBusyConfig\": {\n \"enabled\": \"\",\n \"LookBusyPercentage\": \"\"\n },\n \"formId\": \"\",\n \"formSubmitType\": \"ThankYouMessage\",\n \"formSubmitRedirectUrl\": \"\",\n \"formSubmitThanksMessage\": \"\",\n \"autoConfirm\": \"\",\n \"allowReschedule\": \"\",\n \"allowCancellation\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b979ac16-c372-4b97-840c-650b0cf7479d", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"widgetSlug\": \"\",\n \"widgetType\": \"classic\",\n \"eventTitle\": \"\",\n \"color\": \"\",\n \"active\": \"\",\n \"enabled\": \"\",\n \"groupId\": \"\",\n \"calendarType\": \"event\",\n \"legacyCalendarType\": \"SERVICIO\",\n \"eventType\": \"RoundRobin_OptimizeForEqualDistribution\",\n \"teamMembers\": [\n {\n \"employeeId\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"zoom_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n },\n {\n \"employeeId\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"inbound_call\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n }\n ],\n \"employeeIds\": [\n \"\",\n \"\"\n ],\n \"slotDuration\": \"\",\n \"slotDurationUnit\": \"mins\",\n \"defaultDurationMinutes\": \"\",\n \"slotMinutes\": \"\",\n \"defaultView\": \"MES\",\n \"timeUnit\": \"MINUTES\",\n \"predefinedSlots\": \"\",\n \"slotInterval\": \"\",\n \"slotIntervalUnit\": \"\",\n \"slotBuffer\": \"\",\n \"slotBufferUnit\": \"\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"\",\n \"appoinmentPerSlot\": \"\",\n \"appoinmentPerDay\": \"\",\n \"allowBookingAfter\": \"\",\n \"allowBookingAfterUnit\": \"\",\n \"allowBookingFor\": \"\",\n \"allowBookingForUnit\": \"\",\n \"openHours\": [\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n },\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n }\n ],\n \"availabilities\": [\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n },\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n }\n ],\n \"availabilityType\": \"\",\n \"openingTime\": \"\",\n \"closingTime\": \"\",\n \"enableRecurring\": \"\",\n \"recurring\": {\n \"freq\": \"WEEKLY\",\n \"count\": \"\",\n \"bookingOption\": \"book_next\",\n \"bookingOverlapDefaultStatus\": \"new\"\n },\n \"lookBusyConfig\": {\n \"enabled\": \"\",\n \"LookBusyPercentage\": \"\"\n },\n \"formId\": \"\",\n \"formSubmitType\": \"ThankYouMessage\",\n \"formSubmitRedirectUrl\": \"\",\n \"formSubmitThanksMessage\": \"\",\n \"autoConfirm\": \"\",\n \"allowReschedule\": \"\",\n \"allowCancellation\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "61441298-ce2e-475c-b48c-81598eef45c0", "name": "Delete calendar", "request": { "name": "Delete calendar", "description": { "content": "Deletes a calendar. Send the `If-Match` header with the current ETag for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "9bf590bd-f5b3-4c78-8367-1a9b3260b606", "name": "Calendar deleted", "originalRequest": { "url": { "path": [ "api", "v2", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "11446f59-3b85-4238-a97d-d5f9839f956e", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6b168870-2f2e-4e11-a6b6-c082a527b386", "name": "Authenticated user is missing the `BORRAR_CALENDARIOUI` permission", "originalRequest": { "url": { "path": [ "api", "v2", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "beb54f07-c271-4bbf-a818-14d829d53c09", "name": "Calendar not found", "originalRequest": { "url": { "path": [ "api", "v2", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ee129508-aa2a-4eb9-8420-ee88fdeac8d3", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fea8ad5f-456d-46a6-9ec1-e57228bb47e3", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bab4a71d-b099-415e-b7f4-1c0bd25ecfb9", "name": "Merge-patch calendar", "request": { "name": "Merge-patch calendar", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "55734dcb-6681-4b86-9624-5f70b1043070", "name": "Calendar patched", "originalRequest": { "url": { "path": [ "api", "v2", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"widgetSlug\": \"\",\n \"widgetType\": \"default\",\n \"eventTitle\": \"\",\n \"color\": \"\",\n \"active\": \"\",\n \"enabled\": \"\",\n \"groupId\": \"\",\n \"groupName\": \"\",\n \"calendarType\": \"service_booking\",\n \"legacyCalendarType\": \"SERVICIO\",\n \"eventType\": \"RoundRobin_OptimizeForEqualDistribution\",\n \"teamMembers\": [\n {\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"custom\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"inbound_call\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n },\n {\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"booker\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n }\n ],\n \"employeeIds\": [\n \"\",\n \"\"\n ],\n \"slotDuration\": \"\",\n \"slotDurationUnit\": \"hours\",\n \"defaultDurationMinutes\": \"\",\n \"slotMinutes\": \"\",\n \"defaultView\": \"DIA\",\n \"timeUnit\": \"MINUTES\",\n \"predefinedSlots\": \"\",\n \"slotInterval\": \"\",\n \"slotIntervalUnit\": \"\",\n \"slotBuffer\": \"\",\n \"slotBufferUnit\": \"\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"\",\n \"appoinmentPerSlot\": \"\",\n \"appoinmentPerDay\": \"\",\n \"allowBookingAfter\": \"\",\n \"allowBookingAfterUnit\": \"\",\n \"allowBookingFor\": \"\",\n \"allowBookingForUnit\": \"\",\n \"openHours\": [\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n },\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n }\n ],\n \"availabilities\": [\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n },\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n }\n ],\n \"availabilityType\": \"\",\n \"openingTime\": \"\",\n \"closingTime\": \"\",\n \"enableRecurring\": \"\",\n \"recurring\": {\n \"freq\": \"WEEKLY\",\n \"count\": \"\",\n \"bookingOption\": \"book_next\",\n \"bookingOverlapDefaultStatus\": \"new\"\n },\n \"lookBusyConfig\": {\n \"enabled\": \"\",\n \"LookBusyPercentage\": \"\"\n },\n \"formId\": \"\",\n \"formSubmitType\": \"RedirectURL\",\n \"formSubmitRedirectUrl\": \"\",\n \"formSubmitThanksMessage\": \"\",\n \"autoConfirm\": \"\",\n \"allowReschedule\": \"\",\n \"allowCancellation\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6b4bc7ce-7a8b-4764-bc08-c8cfe5c28d43", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details. Also returned for malformed merge-patch payloads.", "originalRequest": { "url": { "path": [ "api", "v2", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "83ef1d54-b223-4d7f-aa1d-e8333a1b9eac", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d7484afd-2238-4098-9c47-aa353ac386cf", "name": "Authenticated user is missing the `EDITAR_CALENDARIOUI` permission", "originalRequest": { "url": { "path": [ "api", "v2", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0c4b746c-089e-46a3-9ab4-3a45f586f72e", "name": "Calendar not found", "originalRequest": { "url": { "path": [ "api", "v2", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "37f3ee97-3fec-4267-a985-113dfb06594e", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "03c19fb7-eb7d-4937-aa4d-90f56fab6cd2", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "calendars", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Calendar ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "6598861c-2d54-43c2-af16-1745c16e1b0c", "name": "List calendars", "request": { "name": "List calendars", "description": { "content": "Returns a paginated list of calendars with envelope `{data, totalCount, skip, limit, hasMore}`. Default sort is `name:asc`. Limit is capped at 200; skip is clamped to >= 0.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "calendars" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "26344d70-6ba4-4281-aa2a-fc1cc2c0f6a1", "name": "Page of calendars", "originalRequest": { "url": { "path": [ "api", "v2", "calendars" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d04820c3-96db-4ce3-9dd9-03c6da970c3b", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "calendars" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "03b6baf9-e691-445b-9c29-19cff09a2c06", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "calendars" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "64489afe-f1b3-47f1-b1ea-48c0608dc3e4", "name": "Authenticated user is missing the `VER_CALENDARIOUI` permission", "originalRequest": { "url": { "path": [ "api", "v2", "calendars" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ec458fd7-a86f-4504-b870-fbfd6680f354", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "calendars" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "72407a76-5799-4f29-b740-20f61e9001af", "name": "Create calendar", "request": { "name": "Create calendar", "description": { "content": "Creates a new calendar. Business logic runs in the legacy WAR via the internal commands gateway.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "calendars" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"widgetSlug\": \"\",\n \"widgetType\": \"classic\",\n \"eventTitle\": \"\",\n \"color\": \"\",\n \"active\": \"\",\n \"enabled\": \"\",\n \"groupId\": \"\",\n \"calendarType\": \"event\",\n \"legacyCalendarType\": \"SERVICIO\",\n \"eventType\": \"RoundRobin_OptimizeForEqualDistribution\",\n \"teamMembers\": [\n {\n \"employeeId\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"zoom_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n },\n {\n \"employeeId\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"inbound_call\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n }\n ],\n \"employeeIds\": [\n \"\",\n \"\"\n ],\n \"slotDuration\": \"\",\n \"slotDurationUnit\": \"mins\",\n \"defaultDurationMinutes\": \"\",\n \"slotMinutes\": \"\",\n \"defaultView\": \"MES\",\n \"timeUnit\": \"MINUTES\",\n \"predefinedSlots\": \"\",\n \"slotInterval\": \"\",\n \"slotIntervalUnit\": \"\",\n \"slotBuffer\": \"\",\n \"slotBufferUnit\": \"\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"\",\n \"appoinmentPerSlot\": \"\",\n \"appoinmentPerDay\": \"\",\n \"allowBookingAfter\": \"\",\n \"allowBookingAfterUnit\": \"\",\n \"allowBookingFor\": \"\",\n \"allowBookingForUnit\": \"\",\n \"openHours\": [\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n },\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n }\n ],\n \"availabilities\": [\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n },\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n }\n ],\n \"availabilityType\": \"\",\n \"openingTime\": \"\",\n \"closingTime\": \"\",\n \"enableRecurring\": \"\",\n \"recurring\": {\n \"freq\": \"WEEKLY\",\n \"count\": \"\",\n \"bookingOption\": \"book_next\",\n \"bookingOverlapDefaultStatus\": \"new\"\n },\n \"lookBusyConfig\": {\n \"enabled\": \"\",\n \"LookBusyPercentage\": \"\"\n },\n \"formId\": \"\",\n \"formSubmitType\": \"ThankYouMessage\",\n \"formSubmitRedirectUrl\": \"\",\n \"formSubmitThanksMessage\": \"\",\n \"autoConfirm\": \"\",\n \"allowReschedule\": \"\",\n \"allowCancellation\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "31076ad1-de9b-42aa-a531-642d926f7109", "name": "Calendar created", "originalRequest": { "url": { "path": [ "api", "v2", "calendars" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"widgetSlug\": \"\",\n \"widgetType\": \"classic\",\n \"eventTitle\": \"\",\n \"color\": \"\",\n \"active\": \"\",\n \"enabled\": \"\",\n \"groupId\": \"\",\n \"calendarType\": \"event\",\n \"legacyCalendarType\": \"SERVICIO\",\n \"eventType\": \"RoundRobin_OptimizeForEqualDistribution\",\n \"teamMembers\": [\n {\n \"employeeId\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"zoom_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n },\n {\n \"employeeId\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"inbound_call\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n }\n ],\n \"employeeIds\": [\n \"\",\n \"\"\n ],\n \"slotDuration\": \"\",\n \"slotDurationUnit\": \"mins\",\n \"defaultDurationMinutes\": \"\",\n \"slotMinutes\": \"\",\n \"defaultView\": \"MES\",\n \"timeUnit\": \"MINUTES\",\n \"predefinedSlots\": \"\",\n \"slotInterval\": \"\",\n \"slotIntervalUnit\": \"\",\n \"slotBuffer\": \"\",\n \"slotBufferUnit\": \"\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"\",\n \"appoinmentPerSlot\": \"\",\n \"appoinmentPerDay\": \"\",\n \"allowBookingAfter\": \"\",\n \"allowBookingAfterUnit\": \"\",\n \"allowBookingFor\": \"\",\n \"allowBookingForUnit\": \"\",\n \"openHours\": [\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n },\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n }\n ],\n \"availabilities\": [\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n },\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n }\n ],\n \"availabilityType\": \"\",\n \"openingTime\": \"\",\n \"closingTime\": \"\",\n \"enableRecurring\": \"\",\n \"recurring\": {\n \"freq\": \"WEEKLY\",\n \"count\": \"\",\n \"bookingOption\": \"book_next\",\n \"bookingOverlapDefaultStatus\": \"new\"\n },\n \"lookBusyConfig\": {\n \"enabled\": \"\",\n \"LookBusyPercentage\": \"\"\n },\n \"formId\": \"\",\n \"formSubmitType\": \"ThankYouMessage\",\n \"formSubmitRedirectUrl\": \"\",\n \"formSubmitThanksMessage\": \"\",\n \"autoConfirm\": \"\",\n \"allowReschedule\": \"\",\n \"allowCancellation\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"widgetSlug\": \"\",\n \"widgetType\": \"default\",\n \"eventTitle\": \"\",\n \"color\": \"\",\n \"active\": \"\",\n \"enabled\": \"\",\n \"groupId\": \"\",\n \"groupName\": \"\",\n \"calendarType\": \"service_booking\",\n \"legacyCalendarType\": \"SERVICIO\",\n \"eventType\": \"RoundRobin_OptimizeForEqualDistribution\",\n \"teamMembers\": [\n {\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"custom\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"inbound_call\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n },\n {\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"booker\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n }\n ],\n \"employeeIds\": [\n \"\",\n \"\"\n ],\n \"slotDuration\": \"\",\n \"slotDurationUnit\": \"hours\",\n \"defaultDurationMinutes\": \"\",\n \"slotMinutes\": \"\",\n \"defaultView\": \"DIA\",\n \"timeUnit\": \"MINUTES\",\n \"predefinedSlots\": \"\",\n \"slotInterval\": \"\",\n \"slotIntervalUnit\": \"\",\n \"slotBuffer\": \"\",\n \"slotBufferUnit\": \"\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"\",\n \"appoinmentPerSlot\": \"\",\n \"appoinmentPerDay\": \"\",\n \"allowBookingAfter\": \"\",\n \"allowBookingAfterUnit\": \"\",\n \"allowBookingFor\": \"\",\n \"allowBookingForUnit\": \"\",\n \"openHours\": [\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n },\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n }\n ],\n \"availabilities\": [\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n },\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n }\n ],\n \"availabilityType\": \"\",\n \"openingTime\": \"\",\n \"closingTime\": \"\",\n \"enableRecurring\": \"\",\n \"recurring\": {\n \"freq\": \"WEEKLY\",\n \"count\": \"\",\n \"bookingOption\": \"book_next\",\n \"bookingOverlapDefaultStatus\": \"new\"\n },\n \"lookBusyConfig\": {\n \"enabled\": \"\",\n \"LookBusyPercentage\": \"\"\n },\n \"formId\": \"\",\n \"formSubmitType\": \"RedirectURL\",\n \"formSubmitRedirectUrl\": \"\",\n \"formSubmitThanksMessage\": \"\",\n \"autoConfirm\": \"\",\n \"allowReschedule\": \"\",\n \"allowCancellation\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ec3682d7-5b47-4bf0-9ba1-7e956a1d0fd5", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "calendars" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"widgetSlug\": \"\",\n \"widgetType\": \"classic\",\n \"eventTitle\": \"\",\n \"color\": \"\",\n \"active\": \"\",\n \"enabled\": \"\",\n \"groupId\": \"\",\n \"calendarType\": \"event\",\n \"legacyCalendarType\": \"SERVICIO\",\n \"eventType\": \"RoundRobin_OptimizeForEqualDistribution\",\n \"teamMembers\": [\n {\n \"employeeId\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"zoom_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n },\n {\n \"employeeId\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"inbound_call\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n }\n ],\n \"employeeIds\": [\n \"\",\n \"\"\n ],\n \"slotDuration\": \"\",\n \"slotDurationUnit\": \"mins\",\n \"defaultDurationMinutes\": \"\",\n \"slotMinutes\": \"\",\n \"defaultView\": \"MES\",\n \"timeUnit\": \"MINUTES\",\n \"predefinedSlots\": \"\",\n \"slotInterval\": \"\",\n \"slotIntervalUnit\": \"\",\n \"slotBuffer\": \"\",\n \"slotBufferUnit\": \"\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"\",\n \"appoinmentPerSlot\": \"\",\n \"appoinmentPerDay\": \"\",\n \"allowBookingAfter\": \"\",\n \"allowBookingAfterUnit\": \"\",\n \"allowBookingFor\": \"\",\n \"allowBookingForUnit\": \"\",\n \"openHours\": [\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n },\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n }\n ],\n \"availabilities\": [\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n },\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n }\n ],\n \"availabilityType\": \"\",\n \"openingTime\": \"\",\n \"closingTime\": \"\",\n \"enableRecurring\": \"\",\n \"recurring\": {\n \"freq\": \"WEEKLY\",\n \"count\": \"\",\n \"bookingOption\": \"book_next\",\n \"bookingOverlapDefaultStatus\": \"new\"\n },\n \"lookBusyConfig\": {\n \"enabled\": \"\",\n \"LookBusyPercentage\": \"\"\n },\n \"formId\": \"\",\n \"formSubmitType\": \"ThankYouMessage\",\n \"formSubmitRedirectUrl\": \"\",\n \"formSubmitThanksMessage\": \"\",\n \"autoConfirm\": \"\",\n \"allowReschedule\": \"\",\n \"allowCancellation\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "847ebd90-6d43-42fb-a6c1-4d71e1de0054", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "calendars" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"widgetSlug\": \"\",\n \"widgetType\": \"classic\",\n \"eventTitle\": \"\",\n \"color\": \"\",\n \"active\": \"\",\n \"enabled\": \"\",\n \"groupId\": \"\",\n \"calendarType\": \"event\",\n \"legacyCalendarType\": \"SERVICIO\",\n \"eventType\": \"RoundRobin_OptimizeForEqualDistribution\",\n \"teamMembers\": [\n {\n \"employeeId\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"zoom_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n },\n {\n \"employeeId\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"inbound_call\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n }\n ],\n \"employeeIds\": [\n \"\",\n \"\"\n ],\n \"slotDuration\": \"\",\n \"slotDurationUnit\": \"mins\",\n \"defaultDurationMinutes\": \"\",\n \"slotMinutes\": \"\",\n \"defaultView\": \"MES\",\n \"timeUnit\": \"MINUTES\",\n \"predefinedSlots\": \"\",\n \"slotInterval\": \"\",\n \"slotIntervalUnit\": \"\",\n \"slotBuffer\": \"\",\n \"slotBufferUnit\": \"\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"\",\n \"appoinmentPerSlot\": \"\",\n \"appoinmentPerDay\": \"\",\n \"allowBookingAfter\": \"\",\n \"allowBookingAfterUnit\": \"\",\n \"allowBookingFor\": \"\",\n \"allowBookingForUnit\": \"\",\n \"openHours\": [\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n },\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n }\n ],\n \"availabilities\": [\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n },\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n }\n ],\n \"availabilityType\": \"\",\n \"openingTime\": \"\",\n \"closingTime\": \"\",\n \"enableRecurring\": \"\",\n \"recurring\": {\n \"freq\": \"WEEKLY\",\n \"count\": \"\",\n \"bookingOption\": \"book_next\",\n \"bookingOverlapDefaultStatus\": \"new\"\n },\n \"lookBusyConfig\": {\n \"enabled\": \"\",\n \"LookBusyPercentage\": \"\"\n },\n \"formId\": \"\",\n \"formSubmitType\": \"ThankYouMessage\",\n \"formSubmitRedirectUrl\": \"\",\n \"formSubmitThanksMessage\": \"\",\n \"autoConfirm\": \"\",\n \"allowReschedule\": \"\",\n \"allowCancellation\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "58612ebf-8ea5-499d-b428-812da18061b8", "name": "Authenticated user is missing the `CREAR_CALENDARIOUI` permission", "originalRequest": { "url": { "path": [ "api", "v2", "calendars" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"widgetSlug\": \"\",\n \"widgetType\": \"classic\",\n \"eventTitle\": \"\",\n \"color\": \"\",\n \"active\": \"\",\n \"enabled\": \"\",\n \"groupId\": \"\",\n \"calendarType\": \"event\",\n \"legacyCalendarType\": \"SERVICIO\",\n \"eventType\": \"RoundRobin_OptimizeForEqualDistribution\",\n \"teamMembers\": [\n {\n \"employeeId\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"zoom_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n },\n {\n \"employeeId\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"inbound_call\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n }\n ],\n \"employeeIds\": [\n \"\",\n \"\"\n ],\n \"slotDuration\": \"\",\n \"slotDurationUnit\": \"mins\",\n \"defaultDurationMinutes\": \"\",\n \"slotMinutes\": \"\",\n \"defaultView\": \"MES\",\n \"timeUnit\": \"MINUTES\",\n \"predefinedSlots\": \"\",\n \"slotInterval\": \"\",\n \"slotIntervalUnit\": \"\",\n \"slotBuffer\": \"\",\n \"slotBufferUnit\": \"\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"\",\n \"appoinmentPerSlot\": \"\",\n \"appoinmentPerDay\": \"\",\n \"allowBookingAfter\": \"\",\n \"allowBookingAfterUnit\": \"\",\n \"allowBookingFor\": \"\",\n \"allowBookingForUnit\": \"\",\n \"openHours\": [\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n },\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n }\n ],\n \"availabilities\": [\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n },\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n }\n ],\n \"availabilityType\": \"\",\n \"openingTime\": \"\",\n \"closingTime\": \"\",\n \"enableRecurring\": \"\",\n \"recurring\": {\n \"freq\": \"WEEKLY\",\n \"count\": \"\",\n \"bookingOption\": \"book_next\",\n \"bookingOverlapDefaultStatus\": \"new\"\n },\n \"lookBusyConfig\": {\n \"enabled\": \"\",\n \"LookBusyPercentage\": \"\"\n },\n \"formId\": \"\",\n \"formSubmitType\": \"ThankYouMessage\",\n \"formSubmitRedirectUrl\": \"\",\n \"formSubmitThanksMessage\": \"\",\n \"autoConfirm\": \"\",\n \"allowReschedule\": \"\",\n \"allowCancellation\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d4626a96-ff85-4eb8-a816-9e5f756e6847", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "calendars" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"widgetSlug\": \"\",\n \"widgetType\": \"classic\",\n \"eventTitle\": \"\",\n \"color\": \"\",\n \"active\": \"\",\n \"enabled\": \"\",\n \"groupId\": \"\",\n \"calendarType\": \"event\",\n \"legacyCalendarType\": \"SERVICIO\",\n \"eventType\": \"RoundRobin_OptimizeForEqualDistribution\",\n \"teamMembers\": [\n {\n \"employeeId\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"zoom_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n },\n {\n \"employeeId\": \"\",\n \"priority\": \"\",\n \"isPrimary\": \"\",\n \"locationConfigurations\": [\n {\n \"kind\": \"inbound_call\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n },\n {\n \"kind\": \"google_conference\",\n \"location\": \"\",\n \"meetingId\": \"\",\n \"alias\": \"\",\n \"position\": \"\",\n \"zoomOauthId\": \"\"\n }\n ]\n }\n ],\n \"employeeIds\": [\n \"\",\n \"\"\n ],\n \"slotDuration\": \"\",\n \"slotDurationUnit\": \"mins\",\n \"defaultDurationMinutes\": \"\",\n \"slotMinutes\": \"\",\n \"defaultView\": \"MES\",\n \"timeUnit\": \"MINUTES\",\n \"predefinedSlots\": \"\",\n \"slotInterval\": \"\",\n \"slotIntervalUnit\": \"\",\n \"slotBuffer\": \"\",\n \"slotBufferUnit\": \"\",\n \"preBuffer\": \"\",\n \"preBufferUnit\": \"\",\n \"appoinmentPerSlot\": \"\",\n \"appoinmentPerDay\": \"\",\n \"allowBookingAfter\": \"\",\n \"allowBookingAfterUnit\": \"\",\n \"allowBookingFor\": \"\",\n \"allowBookingForUnit\": \"\",\n \"openHours\": [\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n },\n {\n \"daysOfTheWeek\": [\n \"\",\n \"\"\n ],\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ]\n }\n ],\n \"availabilities\": [\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n },\n {\n \"date\": \"\",\n \"hours\": [\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n },\n {\n \"openHour\": \"\",\n \"openMinute\": \"\",\n \"closeHour\": \"\",\n \"closeMinute\": \"\"\n }\n ],\n \"deleted\": \"\"\n }\n ],\n \"availabilityType\": \"\",\n \"openingTime\": \"\",\n \"closingTime\": \"\",\n \"enableRecurring\": \"\",\n \"recurring\": {\n \"freq\": \"WEEKLY\",\n \"count\": \"\",\n \"bookingOption\": \"book_next\",\n \"bookingOverlapDefaultStatus\": \"new\"\n },\n \"lookBusyConfig\": {\n \"enabled\": \"\",\n \"LookBusyPercentage\": \"\"\n },\n \"formId\": \"\",\n \"formSubmitType\": \"ThankYouMessage\",\n \"formSubmitRedirectUrl\": \"\",\n \"formSubmitThanksMessage\": \"\",\n \"autoConfirm\": \"\",\n \"allowReschedule\": \"\",\n \"allowCancellation\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "brands", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "8e64194d-a45d-4bee-98f7-198c070e9bd1", "name": "Get brand by ID", "request": { "name": "Get brand by ID", "description": { "content": "Returns a single brand by its primary key. The response carries a strong `ETag` header with the current version.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "brands", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Brand ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "2b13a2c9-561f-4869-b0b2-f8745ec76e01", "name": "Brand found", "originalRequest": { "url": { "path": [ "api", "v2", "brands", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"groupId\": \"\",\n \"groupName\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "81a463ea-3438-4f41-9874-bd34c9d48c08", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "brands", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "dbab5231-deda-44bb-8b02-a9dc65426ec9", "name": "Authenticated user is missing the `VER_MARCAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "brands", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "eb272899-6632-4a9e-9cb6-5e6f9f01a4fa", "name": "Brand not found", "originalRequest": { "url": { "path": [ "api", "v2", "brands", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "aa7fa72a-dfb2-4f9c-9a69-03787824b1f2", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "brands", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f2f6e758-d29c-4848-9308-6d57d28883d9", "name": "Update brand", "request": { "name": "Update brand", "description": { "content": "Full replacement of an existing brand. Send the `If-Match` header with the current ETag for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "brands", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Brand ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\",\n \"groupId\": \"\",\n \"campaignId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "a98a2550-27cd-4c51-bb28-b07dca7e125c", "name": "Brand updated", "originalRequest": { "url": { "path": [ "api", "v2", "brands", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\",\n \"groupId\": \"\",\n \"campaignId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"groupId\": \"\",\n \"groupName\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c307a506-7bc6-4419-b91f-e53addc1f2de", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "brands", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\",\n \"groupId\": \"\",\n \"campaignId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a955818d-06c1-474f-ba91-e77d6a6920cb", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "brands", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\",\n \"groupId\": \"\",\n \"campaignId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "502a281b-f7bc-4ce5-84c9-64f95facaf5b", "name": "Authenticated user is missing the `EDITAR_MARCAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "brands", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\",\n \"groupId\": \"\",\n \"campaignId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1ef5d12b-4f50-4a08-a937-5b6a6212ad3d", "name": "Brand not found", "originalRequest": { "url": { "path": [ "api", "v2", "brands", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\",\n \"groupId\": \"\",\n \"campaignId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8d656768-8855-431a-9422-8681864e22fb", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "brands", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\",\n \"groupId\": \"\",\n \"campaignId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "39b8cacc-15e3-4c38-98ab-1c1fc91b058d", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "brands", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\",\n \"groupId\": \"\",\n \"campaignId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "645c8dd8-459a-4468-a1b4-5ad9ed359aca", "name": "Delete brand", "request": { "name": "Delete brand", "description": { "content": "Deletes a brand. Send the `If-Match` header with the current ETag for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "brands", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Brand ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "2a185b6c-6166-46e3-92dd-6f65c18fe7fd", "name": "Brand deleted", "originalRequest": { "url": { "path": [ "api", "v2", "brands", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "590f17f0-b8a1-4137-9e50-f867364da30a", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "brands", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ac0a937e-5f24-45e1-85ab-62a75d7ccecc", "name": "Authenticated user is missing the `BORRAR_MARCAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "brands", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7b240710-75ed-441c-a256-b430507262bf", "name": "Brand not found", "originalRequest": { "url": { "path": [ "api", "v2", "brands", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cfb0b7bf-a6ed-40ce-ad1f-47c88ac007f1", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "brands", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "99cda6ee-45df-4f2e-8d1a-f186a0edf669", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "brands", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d07ce9d2-c154-420f-9977-1e2bc66afcf6", "name": "Merge-patch brand", "request": { "name": "Merge-patch brand", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "brands", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Brand ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "7074707f-6a59-419b-933d-fcf44dd15ce4", "name": "Brand patched", "originalRequest": { "url": { "path": [ "api", "v2", "brands", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"groupId\": \"\",\n \"groupName\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "391801d6-5516-419b-a6e7-b3ae7e6aeba1", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details. Also returned for malformed merge-patch payloads.", "originalRequest": { "url": { "path": [ "api", "v2", "brands", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f5ac3e5a-bad8-43de-aa0f-39c34763c4b5", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "brands", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7e224bce-a3d3-4803-82cd-1b6abf583f77", "name": "Authenticated user is missing the `EDITAR_MARCAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "brands", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ba8f0c08-5f79-4df6-bbc2-192f8caf51a2", "name": "Brand not found", "originalRequest": { "url": { "path": [ "api", "v2", "brands", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a1bf76df-fc16-4adc-99cb-5edeef4d12cf", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "brands", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "38f4606e-7321-48e9-bba5-9305a6f27a70", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "brands", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "cd9fc8d8-9b11-40c8-a242-874019d32c93", "name": "List brands", "request": { "name": "List brands", "description": { "content": "Returns a paginated list of brands with envelope `{data, totalCount, skip, limit, hasMore}`. Supports optional RSQL `filter`, `sort` (default `name:asc`), `skip`/`limit` pagination and `modifiedAfter`/`modifiedBefore` bookends. Limit is capped at 200; skip is clamped to >= 0.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "brands" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "9578902b-854a-4128-b370-0aad52cfc49b", "name": "Page of brands", "originalRequest": { "url": { "path": [ "api", "v2", "brands" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b90ad944-cd46-4d47-a840-5cf67ed216ae", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "brands" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7e842ac1-619a-4d0a-bf25-4081fc365ec2", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "brands" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d29456fc-64ee-40b4-9053-baa1011f3aee", "name": "Authenticated user is missing the `VER_MARCAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "brands" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a39520a5-7309-4083-bf0d-d5fb8e159b8e", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "brands" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "180f7759-af7d-4d30-b608-ea6cbffb9396", "name": "Create brand", "request": { "name": "Create brand", "description": { "content": "Creates a new brand. Business logic runs in the legacy WAR via the internal commands gateway.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "brands" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\",\n \"groupId\": \"\",\n \"campaignId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "34f1feff-9dd3-42a3-bb9a-9a08bce2012e", "name": "Brand created", "originalRequest": { "url": { "path": [ "api", "v2", "brands" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\",\n \"groupId\": \"\",\n \"campaignId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"groupId\": \"\",\n \"groupName\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f64c0e9d-667d-409f-b700-3a9fc188d21a", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "brands" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\",\n \"groupId\": \"\",\n \"campaignId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "99455503-f3cf-48b0-bc17-73cd5b44441b", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "brands" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\",\n \"groupId\": \"\",\n \"campaignId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "19b3088f-2e63-4e5b-88ee-3e0d7bf80ff3", "name": "Authenticated user is missing the `CREAR_MARCAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "brands" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\",\n \"groupId\": \"\",\n \"campaignId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "723bbd90-e440-46cf-aecb-bff1710ac835", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "brands" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\",\n \"groupId\": \"\",\n \"campaignId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "379da16a-ccf6-4f01-bce1-50d752203c72", "name": "Bulk delete brands", "request": { "name": "Bulk delete brands", "description": { "content": "Removes every id in `ids` as a single all-or-nothing transaction. If any id is missing or outside the user's company scope the whole operation is rolled back. There is no `If-Match` header on this endpoint because a single ETag cannot represent a heterogeneous selection. The request body is mandatory; clients that cannot send a body on `DELETE` should fall back to the per-id endpoint `DELETE /api/v2/brands/{id}`.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "brands" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "4a810b8e-02e6-422d-9e79-8a86486f5f33", "name": "All entities deleted", "originalRequest": { "url": { "path": [ "api", "v2", "brands" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"deleted\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b724609d-5cc5-4d8f-858d-760eba349823", "name": "Empty `ids`, malformed payload, or unknown id", "originalRequest": { "url": { "path": [ "api", "v2", "brands" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c2e2bbc5-1db4-4f2d-94fd-8bdb871ab252", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "brands" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "51a2fd75-9361-4e42-931d-450b4ed5e4c5", "name": "Authenticated user is missing the `BORRAR_MARCAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "brands" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fd19b969-ebce-4b24-8b1d-ef045dbb4233", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "brands" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "62e8ae7a-54f2-42dd-babc-9975f8fecedd", "name": "Bulk patch brands", "request": { "name": "Bulk patch brands", "description": { "content": "Applies the same `patch` to every id in `ids` as a single all-or-nothing transaction. Editable fields are restricted to a whitelist (`enabled`, `blockType`, `description`, `groupId`, `campaignId`); identity (`code`, `name`), multi-tenant scope (`companyId`) and audit fields are rejected. If any id is missing or outside the user's company scope the whole operation is rolled back. There is no `If-Match` header on this endpoint.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "brands" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"patch\": {\n \"key_0\": \"string\",\n \"key_1\": 4074,\n \"key_2\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "102e8c1a-c945-4d8f-8067-21993add3a7e", "name": "All entities updated", "originalRequest": { "url": { "path": [ "api", "v2", "brands" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"patch\": {\n \"key_0\": \"string\",\n \"key_1\": 4074,\n \"key_2\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"updated\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bf5bbe4d-ae34-4ba7-88d9-8d951783efc3", "name": "Empty `ids`/`patch`, malformed payload, non-whitelisted field or unknown id", "originalRequest": { "url": { "path": [ "api", "v2", "brands" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"patch\": {\n \"key_0\": \"string\",\n \"key_1\": 4074,\n \"key_2\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7381f3f6-195b-4aab-919a-e427485de8de", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "brands" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"patch\": {\n \"key_0\": \"string\",\n \"key_1\": 4074,\n \"key_2\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d1ab7ba6-3263-441e-9a6d-73fb7bacace4", "name": "Authenticated user is missing the `EDITAR_MARCAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "brands" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"patch\": {\n \"key_0\": \"string\",\n \"key_1\": 4074,\n \"key_2\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fd9823c5-caf8-4d37-8403-5c72a9a5f6b8", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "brands" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"patch\": {\n \"key_0\": \"string\",\n \"key_1\": 4074,\n \"key_2\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "new", "description": "", "item": [ { "id": "693dcd0e-8a1a-411c-8270-5110d172740c", "name": "Prototype brand for a creation form", "request": { "name": "Prototype brand for a creation form", "description": { "content": "Returns a non-persisted brand pre-populated with the authenticated user's defaults (current company, `enabled=true`, `blockType=null`). The response carries no `id`, `version` or audit fields. The optional JSON body supplies initialisation hints understood by the WAR; currently recognised: `companyId`, `groupId`, `campaignId` and `copyFromId` (replicates code/name/description from an existing brand). Caller must follow up with `POST /api/v2/brands` to actually persist the entity.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "brands", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "7459620d-d0d1-4b51-8b35-51d6f82514e6", "name": "Brand prototype with defaults", "originalRequest": { "url": { "path": [ "api", "v2", "brands", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"groupId\": \"\",\n \"groupName\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e7ab715b-d62b-4899-b7d8-07f3fe79efda", "name": "Hint references an unknown entity (group, campaign, ...)", "originalRequest": { "url": { "path": [ "api", "v2", "brands", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a94b97a9-dda6-4d25-8ff5-2458a381eb30", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "brands", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0e87e19b-0f88-4d20-946e-5cfcc8dd183a", "name": "Authenticated user is missing the `CREAR_MARCAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "brands", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "49b98221-daee-43c7-96ca-a17adaa338d6", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "brands", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "associated-contact-types", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "27ec9f18-987a-4d83-9cbd-492b70a2801b", "name": "Get associated contact type by ID", "request": { "name": "Get associated contact type by ID", "description": { "content": "Returns a single associated contact type by its primary key.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "associated-contact-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Associated contact type ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "3dcb8e30-4170-46f1-8170-39c5e7655f84", "name": "Associated contact type found", "originalRequest": { "url": { "path": [ "api", "v2", "associated-contact-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Associated contact type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"linkApp\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "02a14bc2-0653-459d-84fa-9eae84812569", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "associated-contact-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Associated contact type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "90cec46a-093e-4007-b40c-e6047122d5a2", "name": "Authenticated user is missing the `VER_TIPOCONTACTOASOCIADO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "associated-contact-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Associated contact type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c20aa0ca-f308-4156-b69f-30c28ab768e5", "name": "Associated contact type not found", "originalRequest": { "url": { "path": [ "api", "v2", "associated-contact-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Associated contact type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e0be21eb-18a7-40b6-a205-8d8364f4e9d2", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "associated-contact-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Associated contact type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7013185d-33d0-461b-a0ff-bda1ca9b7093", "name": "Update associated contact type", "request": { "name": "Update associated contact type", "description": { "content": "Full replacement of an existing associated contact type. Send the `If-Match` header for optimistic concurrency (accepted but ignored ÔÇö not versioned).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "associated-contact-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Associated contact type ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"linkApp\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "c0038674-049c-4d14-a3fe-da01ce760880", "name": "Associated contact type updated", "originalRequest": { "url": { "path": [ "api", "v2", "associated-contact-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Associated contact type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"linkApp\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"linkApp\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c067a5c0-0944-4947-8529-c18cf80280e0", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "associated-contact-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Associated contact type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"linkApp\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ab50cb65-39fd-4d47-90f0-0b2f45e06e01", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "associated-contact-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Associated contact type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"linkApp\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ecc926f3-8a84-446d-a039-f978b1b2b066", "name": "Authenticated user is missing the `EDITAR_TIPOCONTACTOASOCIADO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "associated-contact-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Associated contact type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"linkApp\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c8781974-bade-4b05-9cbb-8f072a9a157d", "name": "Associated contact type not found", "originalRequest": { "url": { "path": [ "api", "v2", "associated-contact-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Associated contact type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"linkApp\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ab201308-bd1e-486e-af2d-eb388fa96fd4", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "associated-contact-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Associated contact type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"linkApp\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "adaad869-3126-47be-9386-937a022feb0e", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "associated-contact-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Associated contact type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"linkApp\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b57915e9-76f3-42f9-912f-33cd1307127d", "name": "Delete associated contact type", "request": { "name": "Delete associated contact type", "description": { "content": "Deletes an associated contact type. Send the `If-Match` header with the current ETag (accepted but ignored ÔÇö not versioned).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "associated-contact-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Associated contact type ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "c3caa51a-7e22-4cf9-b0d5-c351acb51b37", "name": "Associated contact type deleted", "originalRequest": { "url": { "path": [ "api", "v2", "associated-contact-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Associated contact type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f433b8ed-1d65-4707-b700-c461188ea905", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "associated-contact-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Associated contact type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "201d7e26-05cd-473b-bcbc-744172855614", "name": "Authenticated user is missing the `BORRAR_TIPOCONTACTOASOCIADO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "associated-contact-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Associated contact type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f4e75375-8cc0-471d-96bd-a9dd6284772f", "name": "Associated contact type not found", "originalRequest": { "url": { "path": [ "api", "v2", "associated-contact-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Associated contact type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f197a7ff-c064-4ff3-9af4-25331b62390d", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "associated-contact-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Associated contact type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0f708280-1643-48cb-9bae-ed364f3cb333", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "associated-contact-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Associated contact type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "94e0c657-76b3-4d3a-8fe0-363376bdd1c8", "name": "Merge-patch associated contact type", "request": { "name": "Merge-patch associated contact type", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "associated-contact-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Associated contact type ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "af95e709-ad99-43d6-ba0b-069ec6fe69f3", "name": "Associated contact type patched", "originalRequest": { "url": { "path": [ "api", "v2", "associated-contact-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Associated contact type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"linkApp\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "05b57039-807b-4921-8a40-294ad50f4cf3", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "associated-contact-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Associated contact type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "872be2f6-4ebf-47d1-b07f-a9d584f4e1e5", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "associated-contact-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Associated contact type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fabd6673-1cb3-49e6-8a42-441196129ab8", "name": "Authenticated user is missing the `EDITAR_TIPOCONTACTOASOCIADO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "associated-contact-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Associated contact type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "439edeb9-7855-42da-92f8-dfb111040aa0", "name": "Associated contact type not found", "originalRequest": { "url": { "path": [ "api", "v2", "associated-contact-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Associated contact type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cfa224a9-a9d5-4e4a-aaaf-58a6f5e54cc5", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "associated-contact-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Associated contact type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a0e94029-9a6c-473f-b02d-8255b50361aa", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "associated-contact-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Associated contact type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "45549af0-2d69-41ae-b4e3-17c7361a4f87", "name": "List associated contact types", "request": { "name": "List associated contact types", "description": { "content": "Returns a paginated list of associated contact types with envelope `{data, totalCount, skip, limit, hasMore}`. Supports optional RSQL `filter`, `sort` (default `name:asc`), `skip`/`limit` pagination and `modifiedAfter`/`modifiedBefore` bookends.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "associated-contact-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "f6a61a0a-5ee0-423e-af3c-0fa97317fc50", "name": "Page of associated contact types", "originalRequest": { "url": { "path": [ "api", "v2", "associated-contact-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fcb8356f-9927-4381-9ca5-4e885aba9a41", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "associated-contact-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3211789f-e2aa-44d2-9537-556b1fbd1a53", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "associated-contact-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4aa69ba1-38fc-439f-b340-e95ea6dc78ed", "name": "Authenticated user is missing the `VER_TIPOCONTACTOASOCIADO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "associated-contact-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ef531f7d-d48a-4afd-a9e7-0544cfd17925", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "associated-contact-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5b06f85f-e744-40ae-9a3f-58cc3f7bbfc9", "name": "Create associated contact type", "request": { "name": "Create associated contact type", "description": { "content": "Creates a new associated contact type. Business logic runs in the legacy WAR.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "associated-contact-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"linkApp\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "fec9cd35-4604-4885-a882-5fb12dc3101c", "name": "Associated contact type created", "originalRequest": { "url": { "path": [ "api", "v2", "associated-contact-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"linkApp\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"linkApp\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "16f3b886-846e-43b2-8552-6bed21bb3931", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "associated-contact-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"linkApp\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8c878517-d122-4c6c-98f7-b9fac27dd59f", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "associated-contact-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"linkApp\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0c245817-c302-44ce-8674-80df056326f2", "name": "Authenticated user is missing the `CREAR_TIPOCONTACTOASOCIADO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "associated-contact-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"linkApp\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0a121ba3-a191-4d4d-96bb-a031fced7a30", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "associated-contact-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"linkApp\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d84ee464-c785-47a3-a6f9-aa9f8cf465eb", "name": "Bulk delete associated contact types", "request": { "name": "Bulk delete associated contact types", "description": { "content": "Removes every id in `ids` as a single all-or-nothing transaction.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "associated-contact-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "6f307670-78b9-4d81-93de-65f5046fedf5", "name": "All entities deleted", "originalRequest": { "url": { "path": [ "api", "v2", "associated-contact-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"deleted\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "55f5a760-ccee-4ac6-ae2a-80fa6e6f4b15", "name": "Empty `ids` or unknown id", "originalRequest": { "url": { "path": [ "api", "v2", "associated-contact-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "17a16bef-c802-4b71-971e-0ca69373ae20", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "associated-contact-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cdc642e6-72c2-42b0-a208-7b6fb577c1cd", "name": "Authenticated user is missing the `BORRAR_TIPOCONTACTOASOCIADO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "associated-contact-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "52fb807c-0ebc-45c3-8414-d93f70c30a54", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "associated-contact-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9873251e-5631-420e-a309-485e630a3e75", "name": "Bulk patch associated contact types", "request": { "name": "Bulk patch associated contact types", "description": { "content": "Applies the same `patch` to every id in `ids` as a single all-or-nothing transaction. Editable fields: `enabled`, `linkApp`.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "associated-contact-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"patch\": {\n \"key_0\": \"string\",\n \"key_1\": 4074,\n \"key_2\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "82ea8eab-5809-4617-bf90-5a13ef9a269c", "name": "All entities updated", "originalRequest": { "url": { "path": [ "api", "v2", "associated-contact-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"patch\": {\n \"key_0\": \"string\",\n \"key_1\": 4074,\n \"key_2\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"updated\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5b0b7ad1-1003-4927-9ea8-625cfd2d10a7", "name": "Empty `ids`/`patch`, malformed payload or non-whitelisted field", "originalRequest": { "url": { "path": [ "api", "v2", "associated-contact-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"patch\": {\n \"key_0\": \"string\",\n \"key_1\": 4074,\n \"key_2\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "260a62ee-636f-451b-b354-44003ab20baa", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "associated-contact-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"patch\": {\n \"key_0\": \"string\",\n \"key_1\": 4074,\n \"key_2\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "95e8154c-dcff-4a30-beac-63b99ea980e7", "name": "Authenticated user is missing the `EDITAR_TIPOCONTACTOASOCIADO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "associated-contact-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"patch\": {\n \"key_0\": \"string\",\n \"key_1\": 4074,\n \"key_2\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "aed78fb9-68cb-4875-826f-636faedd10a9", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "associated-contact-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"patch\": {\n \"key_0\": \"string\",\n \"key_1\": 4074,\n \"key_2\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "new", "description": "", "item": [ { "id": "ca188c57-671a-468b-9252-b7412007ec05", "name": "Prototype associated contact type for a creation form", "request": { "name": "Prototype associated contact type for a creation form", "description": { "content": "Returns a non-persisted associated contact type pre-populated with backend defaults (`enabled=true`, `linkApp=true`, current company, empty `name`). Optional JSON hints: `companyId`, `copyFromId`. Call `POST /api/v2/associated-contact-types` afterwards to persist.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "associated-contact-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "8e265545-63d3-42bb-9cbf-3af3192f68fb", "name": "Associated contact type prototype with defaults", "originalRequest": { "url": { "path": [ "api", "v2", "associated-contact-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"linkApp\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "351c3650-2e0e-47ce-a771-e451c1d68a20", "name": "Invalid prepare-create hints", "originalRequest": { "url": { "path": [ "api", "v2", "associated-contact-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "351eee41-c440-4746-a9db-f73a6df3afa3", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "associated-contact-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c74c2a43-11d4-4cf0-80bd-da292b89ae9d", "name": "Authenticated user is missing the `CREAR_TIPOCONTACTOASOCIADO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "associated-contact-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "04ba0593-186c-49b4-859c-ce097d991c56", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "associated-contact-types", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "appointments", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "ed588f5d-18c1-496b-b98a-582c4d91a37b", "name": "Get appointment by ID", "request": { "name": "Get appointment by ID", "description": { "content": "Returns a single appointment / calendar event by its primary key.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "appointments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Appointment ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "c3572781-b786-4995-b6f1-7c720f4c5623", "name": "Appointment found", "originalRequest": { "url": { "path": [ "api", "v2", "appointments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"notes\": \"\",\n \"type\": \"MEETING\",\n \"appointmentStatus\": \"NOT_CONFIRMED\",\n \"statusId\": \"\",\n \"statusName\": \"\",\n \"draft\": \"\",\n \"enabled\": \"\",\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"durationMinutes\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"appointmentTypeId\": \"\",\n \"appointmentTypeName\": \"\",\n \"appointmentServiceId\": \"\",\n \"appointmentServiceName\": \"\",\n \"calendarId\": \"\",\n \"calendarName\": \"\",\n \"assignedEmployeeId\": \"\",\n \"assignedEmployeeName\": \"\",\n \"rrule\": \"\",\n \"meetingLocation\": \"\",\n \"lastAction\": \"\",\n \"bookingLog\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1da14a2a-826d-485e-93cc-eb2c58a619c6", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "appointments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7e373896-91e3-4d96-b6a0-d7dde8c87416", "name": "Authenticated user is missing the `VER_EVENTO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "appointments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7aa91c6a-0563-4f41-b732-1140e889773b", "name": "Appointment not found", "originalRequest": { "url": { "path": [ "api", "v2", "appointments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e32865a4-f655-49ee-8330-dc177aced60b", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "appointments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0b3ee7d8-e324-466d-a4b0-7ef8c0228856", "name": "Update appointment", "request": { "name": "Update appointment", "description": { "content": "Full replacement of an existing appointment. Evento has no `OPTLOCK` column, so `If-Match` is accepted for API symmetry but ignored by the command gateway.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "appointments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Appointment ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Accepted for API symmetry; ignored because Evento has no OPTLOCK column.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"notes\": \"\",\n \"type\": \"OPTICS_APPOINTMENT\",\n \"appointmentStatus\": \"SHOWED\",\n \"statusId\": \"\",\n \"draft\": \"\",\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"employeeId\": \"\",\n \"counterpartyId\": \"\",\n \"appointmentTypeId\": \"\",\n \"appointmentServiceId\": \"\",\n \"calendarId\": \"\",\n \"assignedEmployeeId\": \"\",\n \"rrule\": \"\",\n \"meetingLocation\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "273f4edb-0d40-4a87-9dde-72c1d3b66ac5", "name": "Appointment updated", "originalRequest": { "url": { "path": [ "api", "v2", "appointments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Accepted for API symmetry; ignored because Evento has no OPTLOCK column.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"notes\": \"\",\n \"type\": \"OPTICS_APPOINTMENT\",\n \"appointmentStatus\": \"SHOWED\",\n \"statusId\": \"\",\n \"draft\": \"\",\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"employeeId\": \"\",\n \"counterpartyId\": \"\",\n \"appointmentTypeId\": \"\",\n \"appointmentServiceId\": \"\",\n \"calendarId\": \"\",\n \"assignedEmployeeId\": \"\",\n \"rrule\": \"\",\n \"meetingLocation\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"notes\": \"\",\n \"type\": \"MEETING\",\n \"appointmentStatus\": \"NOT_CONFIRMED\",\n \"statusId\": \"\",\n \"statusName\": \"\",\n \"draft\": \"\",\n \"enabled\": \"\",\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"durationMinutes\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"appointmentTypeId\": \"\",\n \"appointmentTypeName\": \"\",\n \"appointmentServiceId\": \"\",\n \"appointmentServiceName\": \"\",\n \"calendarId\": \"\",\n \"calendarName\": \"\",\n \"assignedEmployeeId\": \"\",\n \"assignedEmployeeName\": \"\",\n \"rrule\": \"\",\n \"meetingLocation\": \"\",\n \"lastAction\": \"\",\n \"bookingLog\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fe90d933-b8c5-448b-94eb-1a81cd5f5b68", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "appointments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Accepted for API symmetry; ignored because Evento has no OPTLOCK column.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"notes\": \"\",\n \"type\": \"OPTICS_APPOINTMENT\",\n \"appointmentStatus\": \"SHOWED\",\n \"statusId\": \"\",\n \"draft\": \"\",\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"employeeId\": \"\",\n \"counterpartyId\": \"\",\n \"appointmentTypeId\": \"\",\n \"appointmentServiceId\": \"\",\n \"calendarId\": \"\",\n \"assignedEmployeeId\": \"\",\n \"rrule\": \"\",\n \"meetingLocation\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b4f1c885-4f62-4e05-8ecf-2749592b3da8", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "appointments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Accepted for API symmetry; ignored because Evento has no OPTLOCK column.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"notes\": \"\",\n \"type\": \"OPTICS_APPOINTMENT\",\n \"appointmentStatus\": \"SHOWED\",\n \"statusId\": \"\",\n \"draft\": \"\",\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"employeeId\": \"\",\n \"counterpartyId\": \"\",\n \"appointmentTypeId\": \"\",\n \"appointmentServiceId\": \"\",\n \"calendarId\": \"\",\n \"assignedEmployeeId\": \"\",\n \"rrule\": \"\",\n \"meetingLocation\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c0bf0ce2-9bb6-478a-83c9-30f3fa94dc72", "name": "Authenticated user is missing the `EDITAR_EVENTO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "appointments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Accepted for API symmetry; ignored because Evento has no OPTLOCK column.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"notes\": \"\",\n \"type\": \"OPTICS_APPOINTMENT\",\n \"appointmentStatus\": \"SHOWED\",\n \"statusId\": \"\",\n \"draft\": \"\",\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"employeeId\": \"\",\n \"counterpartyId\": \"\",\n \"appointmentTypeId\": \"\",\n \"appointmentServiceId\": \"\",\n \"calendarId\": \"\",\n \"assignedEmployeeId\": \"\",\n \"rrule\": \"\",\n \"meetingLocation\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1914d3e0-a2e8-4eab-a1a0-319ce61670de", "name": "Appointment not found", "originalRequest": { "url": { "path": [ "api", "v2", "appointments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Accepted for API symmetry; ignored because Evento has no OPTLOCK column.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"notes\": \"\",\n \"type\": \"OPTICS_APPOINTMENT\",\n \"appointmentStatus\": \"SHOWED\",\n \"statusId\": \"\",\n \"draft\": \"\",\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"employeeId\": \"\",\n \"counterpartyId\": \"\",\n \"appointmentTypeId\": \"\",\n \"appointmentServiceId\": \"\",\n \"calendarId\": \"\",\n \"assignedEmployeeId\": \"\",\n \"rrule\": \"\",\n \"meetingLocation\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "32ebced5-279e-44f1-a7c7-8ced843673b6", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "appointments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Accepted for API symmetry; ignored because Evento has no OPTLOCK column.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"notes\": \"\",\n \"type\": \"OPTICS_APPOINTMENT\",\n \"appointmentStatus\": \"SHOWED\",\n \"statusId\": \"\",\n \"draft\": \"\",\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"employeeId\": \"\",\n \"counterpartyId\": \"\",\n \"appointmentTypeId\": \"\",\n \"appointmentServiceId\": \"\",\n \"calendarId\": \"\",\n \"assignedEmployeeId\": \"\",\n \"rrule\": \"\",\n \"meetingLocation\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8e002e69-3763-43a1-85fe-a4f5db17facc", "name": "Delete appointment", "request": { "name": "Delete appointment", "description": { "content": "Deletes an appointment. Evento has no `OPTLOCK` column, so `If-Match` is accepted for API symmetry but ignored.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "appointments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Appointment ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Accepted for API symmetry; ignored because Evento has no OPTLOCK column.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "de3c147c-3f1c-49b0-9d2a-ff944144f515", "name": "Appointment deleted", "originalRequest": { "url": { "path": [ "api", "v2", "appointments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Accepted for API symmetry; ignored because Evento has no OPTLOCK column.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "354a7fa7-e3d8-4dc9-ab26-5f36314a10d0", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "appointments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Accepted for API symmetry; ignored because Evento has no OPTLOCK column.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "806a89b0-8c52-4726-8b9c-a4abf2d1d7af", "name": "Authenticated user is missing the `BORRAR_EVENTO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "appointments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Accepted for API symmetry; ignored because Evento has no OPTLOCK column.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0c51c794-3b12-4c63-8d3d-19cc41d7a607", "name": "Appointment not found", "originalRequest": { "url": { "path": [ "api", "v2", "appointments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Accepted for API symmetry; ignored because Evento has no OPTLOCK column.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8c8dd558-f276-4d83-9dfb-7bed8308a0fa", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "appointments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Accepted for API symmetry; ignored because Evento has no OPTLOCK column.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "df5cb847-f146-4ada-bf59-2a8ae2645c41", "name": "Merge-patch appointment", "request": { "name": "Merge-patch appointment", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control. Evento has no `OPTLOCK` column, so `If-Match` is accepted for API symmetry but ignored by the command gateway.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "appointments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Appointment ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Accepted for API symmetry; ignored because Evento has no OPTLOCK column.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "9329e24f-317b-4da8-8f19-a2197a41cc07", "name": "Appointment patched", "originalRequest": { "url": { "path": [ "api", "v2", "appointments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Accepted for API symmetry; ignored because Evento has no OPTLOCK column.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"notes\": \"\",\n \"type\": \"MEETING\",\n \"appointmentStatus\": \"NOT_CONFIRMED\",\n \"statusId\": \"\",\n \"statusName\": \"\",\n \"draft\": \"\",\n \"enabled\": \"\",\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"durationMinutes\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"appointmentTypeId\": \"\",\n \"appointmentTypeName\": \"\",\n \"appointmentServiceId\": \"\",\n \"appointmentServiceName\": \"\",\n \"calendarId\": \"\",\n \"calendarName\": \"\",\n \"assignedEmployeeId\": \"\",\n \"assignedEmployeeName\": \"\",\n \"rrule\": \"\",\n \"meetingLocation\": \"\",\n \"lastAction\": \"\",\n \"bookingLog\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7f1e3de7-a68c-4a3c-9f06-b673228998fb", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details. Also returned for malformed merge-patch payloads.", "originalRequest": { "url": { "path": [ "api", "v2", "appointments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Accepted for API symmetry; ignored because Evento has no OPTLOCK column.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "58dd070b-7646-4b06-bdac-736b04b18769", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "appointments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Accepted for API symmetry; ignored because Evento has no OPTLOCK column.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "dbadd0c7-fa24-4ae3-906c-3e427fcc620e", "name": "Authenticated user is missing the `EDITAR_EVENTO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "appointments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Accepted for API symmetry; ignored because Evento has no OPTLOCK column.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "eef8dbd8-4943-4774-98cb-fc928975c5b0", "name": "Appointment not found", "originalRequest": { "url": { "path": [ "api", "v2", "appointments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Accepted for API symmetry; ignored because Evento has no OPTLOCK column.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "dcbe674e-bfc7-42ec-aec0-bc55a8ac80d7", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "appointments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Accepted for API symmetry; ignored because Evento has no OPTLOCK column.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "4e0d0b55-d768-49d9-9ac7-351445fdcda0", "name": "List appointments", "request": { "name": "List appointments", "description": { "content": "Returns a paginated list of appointments / calendar events with envelope `{data, totalCount, skip, limit, hasMore}`. Default sort is `lastModifiedAt:desc`. Use `filter=type==MEETING` or `filter=type==OPTICS_APPOINTMENT` to select a single event type. Limit is capped at 200; skip is clamped to >= 0.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "appointments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "27f70faf-e6a0-4891-982b-bc9613444611", "name": "Page of appointments", "originalRequest": { "url": { "path": [ "api", "v2", "appointments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "845f4cd7-3bd1-43c3-95ba-b1fe531c3188", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "appointments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "debf9644-a151-477e-bfe1-9c061ff2883c", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "appointments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "05f2fc37-52e3-4571-b90f-a960c80f543b", "name": "Authenticated user is missing the `VER_EVENTO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "appointments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5c60fff0-79e5-4b74-9c81-510c15c6cb82", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "appointments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5d875fb6-5a5d-463a-bd44-21541efd555d", "name": "Create appointment", "request": { "name": "Create appointment", "description": { "content": "Creates a new calendar appointment. Business logic runs in the legacy WAR via the internal commands gateway.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "appointments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"notes\": \"\",\n \"type\": \"OPTICS_APPOINTMENT\",\n \"appointmentStatus\": \"SHOWED\",\n \"statusId\": \"\",\n \"draft\": \"\",\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"employeeId\": \"\",\n \"counterpartyId\": \"\",\n \"appointmentTypeId\": \"\",\n \"appointmentServiceId\": \"\",\n \"calendarId\": \"\",\n \"assignedEmployeeId\": \"\",\n \"rrule\": \"\",\n \"meetingLocation\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "97aa03a5-1aef-4b1a-8c0b-c052ccf73b25", "name": "Appointment created", "originalRequest": { "url": { "path": [ "api", "v2", "appointments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"notes\": \"\",\n \"type\": \"OPTICS_APPOINTMENT\",\n \"appointmentStatus\": \"SHOWED\",\n \"statusId\": \"\",\n \"draft\": \"\",\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"employeeId\": \"\",\n \"counterpartyId\": \"\",\n \"appointmentTypeId\": \"\",\n \"appointmentServiceId\": \"\",\n \"calendarId\": \"\",\n \"assignedEmployeeId\": \"\",\n \"rrule\": \"\",\n \"meetingLocation\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"notes\": \"\",\n \"type\": \"MEETING\",\n \"appointmentStatus\": \"NOT_CONFIRMED\",\n \"statusId\": \"\",\n \"statusName\": \"\",\n \"draft\": \"\",\n \"enabled\": \"\",\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"durationMinutes\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"appointmentTypeId\": \"\",\n \"appointmentTypeName\": \"\",\n \"appointmentServiceId\": \"\",\n \"appointmentServiceName\": \"\",\n \"calendarId\": \"\",\n \"calendarName\": \"\",\n \"assignedEmployeeId\": \"\",\n \"assignedEmployeeName\": \"\",\n \"rrule\": \"\",\n \"meetingLocation\": \"\",\n \"lastAction\": \"\",\n \"bookingLog\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "24178c50-fe7b-446a-b4e5-97fbc5a0c5f9", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "appointments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"notes\": \"\",\n \"type\": \"OPTICS_APPOINTMENT\",\n \"appointmentStatus\": \"SHOWED\",\n \"statusId\": \"\",\n \"draft\": \"\",\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"employeeId\": \"\",\n \"counterpartyId\": \"\",\n \"appointmentTypeId\": \"\",\n \"appointmentServiceId\": \"\",\n \"calendarId\": \"\",\n \"assignedEmployeeId\": \"\",\n \"rrule\": \"\",\n \"meetingLocation\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f19c954f-c4e0-44e2-bae2-2c2bfa20e599", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "appointments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"notes\": \"\",\n \"type\": \"OPTICS_APPOINTMENT\",\n \"appointmentStatus\": \"SHOWED\",\n \"statusId\": \"\",\n \"draft\": \"\",\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"employeeId\": \"\",\n \"counterpartyId\": \"\",\n \"appointmentTypeId\": \"\",\n \"appointmentServiceId\": \"\",\n \"calendarId\": \"\",\n \"assignedEmployeeId\": \"\",\n \"rrule\": \"\",\n \"meetingLocation\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "94ee4d3f-2d91-4240-b00c-5637d4ddf89e", "name": "Authenticated user is missing the `CREAR_EVENTO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "appointments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"notes\": \"\",\n \"type\": \"OPTICS_APPOINTMENT\",\n \"appointmentStatus\": \"SHOWED\",\n \"statusId\": \"\",\n \"draft\": \"\",\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"employeeId\": \"\",\n \"counterpartyId\": \"\",\n \"appointmentTypeId\": \"\",\n \"appointmentServiceId\": \"\",\n \"calendarId\": \"\",\n \"assignedEmployeeId\": \"\",\n \"rrule\": \"\",\n \"meetingLocation\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "799bb463-3bac-4ebc-a970-8c1ef93041da", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "appointments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"notes\": \"\",\n \"type\": \"OPTICS_APPOINTMENT\",\n \"appointmentStatus\": \"SHOWED\",\n \"statusId\": \"\",\n \"draft\": \"\",\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"companyId\": \"\",\n \"warehouseId\": \"\",\n \"employeeId\": \"\",\n \"counterpartyId\": \"\",\n \"appointmentTypeId\": \"\",\n \"appointmentServiceId\": \"\",\n \"calendarId\": \"\",\n \"assignedEmployeeId\": \"\",\n \"rrule\": \"\",\n \"meetingLocation\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "appointment-types", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "79408ea1-2eeb-4b55-abe6-63bf261994c3", "name": "Get appointment type by ID", "request": { "name": "Get appointment type by ID", "description": { "content": "Returns a single appointment type by its primary key. The response carries a strong `ETag` header with the current version.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "appointment-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Appointment type ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "4d94e775-6335-4eae-8a0d-e229f65f6e92", "name": "Appointment type found", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"color\": \"PURPLE\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"serviceIds\": [\n \"\",\n \"\"\n ],\n \"services\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c8f8bead-0481-4164-8eff-42b2538199a1", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d1e2905e-cb3d-4634-af6c-55a5fa94a5d4", "name": "Authenticated user is missing the `VER_TIPOCITA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9b7f33a3-c306-4ef0-9625-3463de3e67b5", "name": "Appointment type not found", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f95a3e5a-8e8e-4363-a7e4-a34e2346769e", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4de7fdd5-d374-4375-aea3-57f5a2599f09", "name": "Update appointment type", "request": { "name": "Update appointment type", "description": { "content": "Full replacement of an existing appointment type. Send the `If-Match` header with the current ETag for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "appointment-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Appointment type ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"color\": \"GREEN\",\n \"companyId\": \"\",\n \"serviceIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "20c3e59d-4932-4c40-9c10-020eea4cd539", "name": "Appointment type updated", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"color\": \"GREEN\",\n \"companyId\": \"\",\n \"serviceIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"color\": \"PURPLE\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"serviceIds\": [\n \"\",\n \"\"\n ],\n \"services\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7b1cb832-8ef3-40bb-ae1a-728b15052ae0", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"color\": \"GREEN\",\n \"companyId\": \"\",\n \"serviceIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c7506870-abc6-4ce1-af7f-e43b3211eca5", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"color\": \"GREEN\",\n \"companyId\": \"\",\n \"serviceIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d0b2c0af-7070-42dc-b595-ab8ef97c23f1", "name": "Authenticated user is missing the `EDITAR_TIPOCITA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"color\": \"GREEN\",\n \"companyId\": \"\",\n \"serviceIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b328fd19-05f5-4968-962b-72d37ac49e45", "name": "Appointment type not found", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"color\": \"GREEN\",\n \"companyId\": \"\",\n \"serviceIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5e9c324b-5e10-4485-b3ad-e52b24e964a6", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"color\": \"GREEN\",\n \"companyId\": \"\",\n \"serviceIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c7eda67c-178e-457b-ac55-2475076968c6", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"color\": \"GREEN\",\n \"companyId\": \"\",\n \"serviceIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7d5a0ebf-4103-470a-b3bd-106c4ca73e13", "name": "Delete appointment type", "request": { "name": "Delete appointment type", "description": { "content": "Deletes an appointment type. Send the `If-Match` header with the current ETag for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "appointment-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Appointment type ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "e07ef3b8-76df-406b-82da-023b2eeab107", "name": "Appointment type deleted", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f0afd3c2-6e61-4a47-b24a-7851cca58d74", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a607ab05-d186-436b-a5fc-45aae3c6cebf", "name": "Authenticated user is missing the `BORRAR_TIPOCITA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c625dc6b-44ff-499e-9dbb-856269cea244", "name": "Appointment type not found", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7a851d3c-214e-48a2-a727-e86bd43f9a95", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "396a4843-037c-49b4-958e-33165a3fc8c1", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3c34329e-b212-4a5a-97c7-8617eac312d4", "name": "Merge-patch appointment type", "request": { "name": "Merge-patch appointment type", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "appointment-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Appointment type ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "eff7f16b-3bb8-43b1-a731-982f2ef45a7c", "name": "Appointment type patched", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"color\": \"PURPLE\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"serviceIds\": [\n \"\",\n \"\"\n ],\n \"services\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "80df2bab-452f-49f9-ab5d-0cc57a0548ce", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details. Also returned for malformed merge-patch payloads.", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c71ae097-8270-4ac1-9265-fdf088dec928", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4d81172b-a927-41fb-b7f8-1179c4320a61", "name": "Authenticated user is missing the `EDITAR_TIPOCITA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "838f6cc0-e7ed-452b-8360-cc88d3097b60", "name": "Appointment type not found", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9d537ebb-185e-4d28-9303-de8120172dad", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "98ebdb52-9194-4750-8841-89b689719607", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment type ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "ae6b68d5-bd50-4369-a635-082eb27a8f0a", "name": "List appointment types", "request": { "name": "List appointment types", "description": { "content": "Returns a paginated list of appointment types with envelope `{data, totalCount, skip, limit, hasMore}`. Default sort is `name:asc`. Limit is capped at 200; skip is clamped to >= 0.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "appointment-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "06138124-67f2-460e-9dcf-776147c30174", "name": "Page of appointment types", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "85d45809-9a65-4f62-94f2-47a4c81166c7", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f7cc7b34-5264-49d2-9179-1c9c91ced582", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3c18fdb0-09c9-4518-8868-3492a3b41938", "name": "Authenticated user is missing the `VER_TIPOCITA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2718bb8c-cef3-4cf9-b26f-e1299481c9a3", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3d156ef1-6732-4db8-88db-6505c07c9fc9", "name": "Create appointment type", "request": { "name": "Create appointment type", "description": { "content": "Creates a new appointment type. Business logic runs in the legacy WAR via the internal commands gateway.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "appointment-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"color\": \"GREEN\",\n \"companyId\": \"\",\n \"serviceIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "b8e57bd7-9135-4eae-8ee1-7db3f5a02d46", "name": "Appointment type created", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"color\": \"GREEN\",\n \"companyId\": \"\",\n \"serviceIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"color\": \"PURPLE\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"serviceIds\": [\n \"\",\n \"\"\n ],\n \"services\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "58c7927e-a96b-49dd-b7b7-c73a25ba9b27", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"color\": \"GREEN\",\n \"companyId\": \"\",\n \"serviceIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2433cbec-4e10-43f7-b867-e2cab2651ecb", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"color\": \"GREEN\",\n \"companyId\": \"\",\n \"serviceIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c1f07501-a1fe-43d6-b740-9daefaf0f7ca", "name": "Authenticated user is missing the `CREAR_TIPOCITA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"color\": \"GREEN\",\n \"companyId\": \"\",\n \"serviceIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "aa8a4f14-8dfe-4296-b90a-0e08217db006", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"color\": \"GREEN\",\n \"companyId\": \"\",\n \"serviceIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "appointment-services", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "4d2e3bf6-0eaa-44fb-857c-adff7a0e9307", "name": "Get appointment service by ID", "request": { "name": "Get appointment service by ID", "description": { "content": "Returns a single appointment service by its primary key. The response carries a strong `ETag` header with the current version.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "appointment-services", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Appointment service ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "9dab41f3-ae87-49d5-9a50-8c67dae83981", "name": "Appointment service found", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-services", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment service ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"appointmentTypeIds\": [\n \"\",\n \"\"\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "caacc38e-5e1c-4835-86bb-5a4c2aca8053", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-services", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment service ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fb939bc3-b1a7-461c-91f0-4a5b609aed2e", "name": "Authenticated user is missing the `VER_TIPOCITASERVICIO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-services", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment service ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0983e300-55e5-4a01-a412-13f4d354d8ab", "name": "Appointment service not found", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-services", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment service ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a2378133-a5b1-49be-b67d-4effcd124de8", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-services", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment service ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4661a5ad-53de-4439-a2cc-04e26c44261b", "name": "Update appointment service", "request": { "name": "Update appointment service", "description": { "content": "Full replacement of an existing appointment service. Send the `If-Match` header with the current ETag for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "appointment-services", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Appointment service ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"appointmentTypeIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "d34ae9bb-b04d-40a4-bbfe-a48719b700e6", "name": "Appointment service updated", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-services", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment service ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"appointmentTypeIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"appointmentTypeIds\": [\n \"\",\n \"\"\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7b423ad6-e4d3-451e-a7fe-70e277864029", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-services", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment service ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"appointmentTypeIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "31d3a44c-bd5b-482b-a104-321a85c87595", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-services", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment service ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"appointmentTypeIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2c067d55-aa58-4865-b895-a15cdfed7791", "name": "Authenticated user is missing the `EDITAR_TIPOCITASERVICIO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-services", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment service ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"appointmentTypeIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "af8fb134-b3cc-4207-90c7-2aaf674a026e", "name": "Appointment service not found", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-services", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment service ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"appointmentTypeIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "34b12c3e-4e02-423a-9d2a-1b28f53a76f9", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-services", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment service ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"appointmentTypeIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0bc24dd9-22f9-469c-9b46-cd7c8440b87b", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-services", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment service ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"appointmentTypeIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2e4814a3-a9ea-439a-91e3-23fb0b0b09fa", "name": "Delete appointment service", "request": { "name": "Delete appointment service", "description": { "content": "Deletes an appointment service. Send the `If-Match` header with the current ETag for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "appointment-services", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Appointment service ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "8a793ca2-5c54-4fb4-8e13-3e2726a5ab65", "name": "Appointment service deleted", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-services", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment service ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "34dc5b31-fc4e-45a6-b1e1-6965894147a9", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-services", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment service ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "68ec66aa-ca6a-429d-b741-c035e90cef93", "name": "Authenticated user is missing the `BORRAR_TIPOCITASERVICIO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-services", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment service ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0832ac69-9496-4202-8937-b9438d974150", "name": "Appointment service not found", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-services", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment service ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1e70472d-2b5f-4146-87a1-7505a47a6bce", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-services", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment service ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "352c62eb-b011-4dfd-a019-393d6d2faf0e", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-services", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment service ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "38477d6d-e303-4382-87a0-d067ccc951e6", "name": "Merge-patch appointment service", "request": { "name": "Merge-patch appointment service", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "appointment-services", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Appointment service ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "99576938-8ef5-4db4-aaab-3914bfc9c62e", "name": "Appointment service patched", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-services", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment service ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"appointmentTypeIds\": [\n \"\",\n \"\"\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e41695ca-15bc-4aee-8217-a25e7422d0ec", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details. Also returned for malformed merge-patch payloads.", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-services", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment service ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "41e094dc-e32e-4e6f-b7b4-ad49043957d6", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-services", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment service ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "76e43820-9132-4bbc-8541-09ce8c3304a3", "name": "Authenticated user is missing the `EDITAR_TIPOCITASERVICIO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-services", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment service ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8481c8ad-1b82-4e45-88ab-1ad3cbbf95f3", "name": "Appointment service not found", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-services", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment service ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "042f7d73-37dc-4e8b-b549-72f616c70a21", "name": "Version conflict ÔÇö the resource was modified by another user since the version supplied in `If-Match` was issued.", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-services", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment service ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "67a0dbdc-7366-413b-96e9-1130564b37c1", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-services", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Appointment service ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "f8ee5bb2-3b70-4457-84de-7f0bb1a6c934", "name": "List appointment services", "request": { "name": "List appointment services", "description": { "content": "Returns a paginated list of appointment services with envelope `{data, totalCount, skip, limit, hasMore}`. Default sort is `name:asc`. Limit is capped at 200; skip is clamped to >= 0.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "appointment-services" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "425d7fc2-12a1-4dbc-91e1-1d32d0d93fdd", "name": "Page of appointment services", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-services" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "54e381ad-263b-4e9d-ab4b-1f84a52f15e2", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-services" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "461672ae-d563-422d-9264-24056b8f1d3b", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-services" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "de5a9889-64e2-47cb-9109-2ae149886c14", "name": "Authenticated user is missing the `VER_TIPOCITASERVICIO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-services" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9c96a137-c10b-4574-a230-83ef41c46839", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-services" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "name:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6b511106-7661-43ce-97b9-55aa0c77fa9a", "name": "Create appointment service", "request": { "name": "Create appointment service", "description": { "content": "Creates a new appointment service. Business logic runs in the legacy WAR via the internal commands gateway.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "appointment-services" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"appointmentTypeIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "aa6e17ee-ef9d-47b2-8246-0afc703fa428", "name": "Appointment service created", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-services" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"appointmentTypeIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"appointmentTypeIds\": [\n \"\",\n \"\"\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f3e9e273-d82f-4e54-847b-bf0202e1768e", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-services" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"appointmentTypeIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "db64192d-680c-4fe9-8f10-916b79b40f6c", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-services" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"appointmentTypeIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2b9e4463-8967-4e93-973f-109ac87940c6", "name": "Authenticated user is missing the `CREAR_TIPOCITASERVICIO` permission", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-services" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"appointmentTypeIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ba2e5d2a-24ba-4955-b0bd-70884b87aa0d", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "appointment-services" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"appointmentTypeIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "activities", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "203c5eca-a399-4218-92fa-1a02f04f5652", "name": "Get activity by ID", "request": { "name": "Get activity by ID", "description": { "content": "Returns a single accounting activity by its primary key.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "activities", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Activity ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "006708e5-2610-49bb-829f-9e4b4e842833", "name": "Activity found", "originalRequest": { "url": { "path": [ "api", "v2", "activities", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Activity ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e56f2096-cd0b-4dcb-a234-222cdc5d9e17", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "activities", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Activity ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "87ed0db6-6c1c-4b87-af1e-0b1704df6d09", "name": "Authenticated user is missing the `VER_ACTIVIDADES` permission", "originalRequest": { "url": { "path": [ "api", "v2", "activities", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Activity ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "48698a68-8195-4c4c-a101-618dafb5fc51", "name": "Activity not found", "originalRequest": { "url": { "path": [ "api", "v2", "activities", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Activity ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "583edc9a-91d1-4fc4-b918-839202be00b2", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "activities", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Activity ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1cb863c9-c58d-45ab-bf08-ab33124d2a8c", "name": "Update activity", "request": { "name": "Update activity", "description": { "content": "Full replacement of an existing accounting activity.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "activities", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Activity ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "6e7e353c-938a-46f8-9035-f1ce94e461a7", "name": "Activity updated", "originalRequest": { "url": { "path": [ "api", "v2", "activities", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Activity ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "55eaf644-24b4-4986-9c03-3d4b1c1afae3", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "activities", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Activity ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6c7cf49c-9866-46eb-8b9a-33362e560a7d", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "activities", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Activity ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e622c362-c4dd-4aae-a9ea-087b60f2d8c0", "name": "Authenticated user is missing the `EDITAR_ACTIVIDADES` permission", "originalRequest": { "url": { "path": [ "api", "v2", "activities", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Activity ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3d1c23c0-0c55-4b6f-a6ba-61e2673465b5", "name": "Activity not found", "originalRequest": { "url": { "path": [ "api", "v2", "activities", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Activity ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4c354d3d-799d-418d-a5c4-4991a4c544fa", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "activities", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Activity ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b90ffed8-0d3a-4bb1-8b46-2c6d9d89837d", "name": "Delete activity", "request": { "name": "Delete activity", "description": { "content": "Deletes an accounting activity.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "activities", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Activity ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "91410ab8-b05a-4aac-85c4-60e63725f982", "name": "Activity deleted", "originalRequest": { "url": { "path": [ "api", "v2", "activities", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Activity ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ce918a79-bb30-46a9-b515-266c4addb89b", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "activities", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Activity ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f8536b31-3d21-410c-a0fd-bef63fb12176", "name": "Authenticated user is missing the `BORRAR_ACTIVIDADES` permission", "originalRequest": { "url": { "path": [ "api", "v2", "activities", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Activity ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b613829d-08d5-4a35-8252-36eeb114630e", "name": "Activity not found", "originalRequest": { "url": { "path": [ "api", "v2", "activities", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Activity ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "976b5da4-9092-4cf4-a1ef-3f296e85025e", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "activities", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Activity ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e76999ec-b7b4-4912-99c9-f0ecbc1418c9", "name": "Merge-patch activity", "request": { "name": "Merge-patch activity", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "activities", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Activity ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "1111563d-e1a9-4688-9117-60c390eee72d", "name": "Activity patched", "originalRequest": { "url": { "path": [ "api", "v2", "activities", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Activity ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "530dedd3-dddf-4c46-a9dc-1c76f0ecf7b3", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details. Also returned for malformed merge-patch payloads.", "originalRequest": { "url": { "path": [ "api", "v2", "activities", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Activity ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "af3c0899-0957-4803-a38e-4eb4e3349843", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "activities", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Activity ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "47e287d9-7343-4a21-9467-79d6b5e5e03e", "name": "Authenticated user is missing the `EDITAR_ACTIVIDADES` permission", "originalRequest": { "url": { "path": [ "api", "v2", "activities", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Activity ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "831e7d2b-780e-487d-8969-26deedae032e", "name": "Activity not found", "originalRequest": { "url": { "path": [ "api", "v2", "activities", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Activity ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a1d36698-c5ca-4330-9331-d95a4db36cf0", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "activities", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Activity ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "65977a52-3b91-4ef7-86c6-322949d52bc3", "name": "List activities", "request": { "name": "List activities", "description": { "content": "Returns a paginated list of accounting activities with envelope `{data, totalCount, skip, limit, hasMore}`. Supports optional RSQL `filter`, `sort` (default `code:asc`), `skip`/`limit` pagination and `modifiedAfter`/`modifiedBefore` bookends.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "activities" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "code:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "e557a1e2-94b2-451e-8481-b5bd63484faf", "name": "Page of activities", "originalRequest": { "url": { "path": [ "api", "v2", "activities" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "code:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "31827e87-402a-439c-a784-eb64d2e32560", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "activities" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "code:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5f4a1675-0f6c-4e52-88a1-365a78da3546", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "activities" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "code:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ed7246e9-3139-4e67-990a-2ae4fa6018a1", "name": "Authenticated user is missing the `VER_ACTIVIDADES` permission", "originalRequest": { "url": { "path": [ "api", "v2", "activities" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "code:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "50f0ae63-c206-4988-843d-3328fe90ab20", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "activities" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "code:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "031d5f93-fb1b-4d67-80e7-36bafc174864", "name": "Create activity", "request": { "name": "Create activity", "description": { "content": "Creates a new accounting activity via the internal commands gateway.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "activities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "ed1e448e-ed82-4f6d-9cf5-91306d51d99e", "name": "Activity created", "originalRequest": { "url": { "path": [ "api", "v2", "activities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f8a4f6f8-0681-41ab-bbb5-9fac4fa1840c", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "activities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0c9b2a5f-2f8b-486b-bbaa-0f4932556f9b", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "activities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "327d99cc-6538-4d2d-96a8-daa5297d02de", "name": "Authenticated user is missing the `CREAR_ACTIVIDADES` permission", "originalRequest": { "url": { "path": [ "api", "v2", "activities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "539cc104-c4ec-4a06-90df-6f0fa2c06ff8", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "activities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "new", "description": "", "item": [ { "id": "d2582991-e7a7-4281-bbfa-cea6b7274338", "name": "Prototype activity for a creation form", "request": { "name": "Prototype activity for a creation form", "description": { "content": "Returns a non-persisted activity pre-populated with backend defaults (`enabled=true`, current company, next available `code`). Optional JSON hints: `companyId`, `copyFromId`. Call `POST /api/v2/activities` afterwards to persist.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "activities", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "d5565625-4397-40af-b333-bda700ba0291", "name": "Activity prototype with defaults", "originalRequest": { "url": { "path": [ "api", "v2", "activities", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e91a42a4-a95f-4bc6-8fc4-340c34b8876b", "name": "Invalid prepare-create hints", "originalRequest": { "url": { "path": [ "api", "v2", "activities", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a504a6ea-ff1a-4892-bfa6-59ffa52aa7ad", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "activities", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ffa26655-985e-4824-bfd4-debfdd333d74", "name": "Authenticated user is missing the `CREAR_ACTIVIDADES` permission", "originalRequest": { "url": { "path": [ "api", "v2", "activities", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "95e6722d-46f3-4c98-8242-86b747a22aa7", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "activities", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "accounting-accounts", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "f3db5502-a74f-48f4-ae2b-bbe7c499e996", "name": "Get accounting account by ID", "request": { "name": "Get accounting account by ID", "description": { "content": "Returns a single chart-of-accounts entry.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "accounting-accounts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Accounting account ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "fea881b0-f10e-4c72-b718-d462ec205099", "name": "Accounting account found", "originalRequest": { "url": { "path": [ "api", "v2", "accounting-accounts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Accounting account ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"account\": \"\",\n \"prefix\": \"\",\n \"suffix\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"rollupAccount\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1c593691-c583-42ed-a023-0b05b185fab4", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "accounting-accounts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Accounting account ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "922cebb0-bc47-47e1-af93-a63330a0af19", "name": "Authenticated user is missing the `VER_CUENTASCONTABLES` permission", "originalRequest": { "url": { "path": [ "api", "v2", "accounting-accounts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Accounting account ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "90595e6d-80fc-4c60-9f42-544e502615d4", "name": "Accounting account not found", "originalRequest": { "url": { "path": [ "api", "v2", "accounting-accounts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Accounting account ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e17d0b3f-b759-4f9c-9a69-5333478786c4", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "accounting-accounts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Accounting account ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e59b9b98-a461-4452-a8a8-16ed4af4a91b", "name": "Update accounting account", "request": { "name": "Update accounting account", "description": { "content": "Full replacement. The account number must keep the company's configured length.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "accounting-accounts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Accounting account ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"account\": \"\",\n \"prefix\": \"\",\n \"suffix\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "c51f07d3-dcb7-4503-b948-bff55adcbb2c", "name": "Accounting account updated", "originalRequest": { "url": { "path": [ "api", "v2", "accounting-accounts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Accounting account ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"account\": \"\",\n \"prefix\": \"\",\n \"suffix\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"account\": \"\",\n \"prefix\": \"\",\n \"suffix\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"rollupAccount\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "aff58ebc-9b5c-4463-9ec5-57ef7bde2608", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "accounting-accounts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Accounting account ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"account\": \"\",\n \"prefix\": \"\",\n \"suffix\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "14a956d4-ad45-4bbd-b72b-ca573571c90e", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "accounting-accounts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Accounting account ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"account\": \"\",\n \"prefix\": \"\",\n \"suffix\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6c1aa3e8-435b-4967-bd9a-950d4129f25c", "name": "Authenticated user is missing the `EDITAR_CUENTASCONTABLES` permission", "originalRequest": { "url": { "path": [ "api", "v2", "accounting-accounts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Accounting account ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"account\": \"\",\n \"prefix\": \"\",\n \"suffix\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e979cc00-1946-4196-a320-2d20deef75e5", "name": "Accounting account not found", "originalRequest": { "url": { "path": [ "api", "v2", "accounting-accounts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Accounting account ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"account\": \"\",\n \"prefix\": \"\",\n \"suffix\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8c14ef38-2365-47f7-80cb-1bdca9af651b", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "accounting-accounts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Accounting account ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"account\": \"\",\n \"prefix\": \"\",\n \"suffix\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "83a2b276-a5b1-4661-8dfd-e4a7940d5347", "name": "Delete accounting account", "request": { "name": "Delete accounting account", "description": { "content": "Deletes a sub-account. Rollup (parent) accounts cannot be deleted. If-Match is accepted but ignored (CuentaContable is not versioned).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "accounting-accounts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Accounting account ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "2180c1ed-72b6-468e-baf3-34eca815f6fa", "name": "Accounting account deleted", "originalRequest": { "url": { "path": [ "api", "v2", "accounting-accounts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Accounting account ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "168677c7-a15a-4e7f-8912-35c6e656a293", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "accounting-accounts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Accounting account ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5ad7d753-52ad-4cff-8d81-e14cee84f252", "name": "Authenticated user is missing the `BORRAR_CUENTASCONTABLES` permission", "originalRequest": { "url": { "path": [ "api", "v2", "accounting-accounts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Accounting account ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "df252883-3d00-4f8b-aea7-97e6bc034d07", "name": "Accounting account not found", "originalRequest": { "url": { "path": [ "api", "v2", "accounting-accounts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Accounting account ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "30fb7a88-9270-4caf-9b64-b105ea6515ba", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "accounting-accounts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Accounting account ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "59493f5f-308a-464f-9cd6-6744b9e317f5", "name": "Merge-patch accounting account", "request": { "name": "Merge-patch accounting account", "description": { "content": "RFC 7396 merge-patch over `application/merge-patch+json`. Send only the fields you want to change; include a field with value `null` to remove it. Use the `If-Match` header for optimistic concurrency control.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "accounting-accounts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Accounting account ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "7e7ac451-10a7-41ef-bc8b-56c923fdbb47", "name": "Accounting account patched", "originalRequest": { "url": { "path": [ "api", "v2", "accounting-accounts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Accounting account ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"account\": \"\",\n \"prefix\": \"\",\n \"suffix\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"rollupAccount\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "dd0386f7-4452-49a5-a5fd-671e01f82585", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details. Also returned for malformed merge-patch payloads.", "originalRequest": { "url": { "path": [ "api", "v2", "accounting-accounts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Accounting account ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a7c5e11f-2137-4f7f-94b6-6c8d9d819b99", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "accounting-accounts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Accounting account ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "be4a3c8b-da2f-4a26-a205-2c2bfa31c819", "name": "Authenticated user is missing the `EDITAR_CUENTASCONTABLES` permission", "originalRequest": { "url": { "path": [ "api", "v2", "accounting-accounts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Accounting account ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "22934864-781b-4705-801d-80afc363aad8", "name": "Accounting account not found", "originalRequest": { "url": { "path": [ "api", "v2", "accounting-accounts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Accounting account ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f32e961e-50a2-483a-b403-6f921a846779", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "accounting-accounts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Accounting account ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optimistic locking. Send the current entity version (the value of the `ETag` header from the last GET / POST / PUT / PATCH response). If the server's stored version does not match, the request fails with `409 Conflict`. Both strong (`\"3\"`) and weak (`W/\"3\"`) forms are accepted. Send no header (or empty) to skip the version check.", "type": "text/plain" }, "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "5a55c3bd-ce8d-463a-aabf-dbd9f701e483", "name": "List accounting accounts", "request": { "name": "List accounting accounts", "description": { "content": "Paginated list with optional RSQL filter and sort (default lastModifiedAt:desc).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "accounting-accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "cf839dd6-99eb-491d-a2f4-c54d083f6426", "name": "Page of accounting accounts", "originalRequest": { "url": { "path": [ "api", "v2", "accounting-accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4e134afc-710f-49b3-91a2-4881deb45d55", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "accounting-accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c8d58559-74ed-483e-b32f-a89686e5d606", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "accounting-accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "88e76083-8e75-4d25-817b-0299b8d2e07a", "name": "Authenticated user is missing the `VER_CUENTASCONTABLES` permission", "originalRequest": { "url": { "path": [ "api", "v2", "accounting-accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4483b6ce-43d5-4a19-bf92-84267ccd8d86", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "accounting-accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "lastModifiedAt:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c6925ba8-b5a4-4bf8-ac1e-00f6285f0f6d", "name": "Create accounting account", "request": { "name": "Create accounting account", "description": { "content": "Persists via the internal commands gateway. The full account number must match the company's configured length (typically 8 digits). Supply either `account` or `prefix`+`suffix`; when prefix/suffix are provided the server recomputes `account`.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "accounting-accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"account\": \"\",\n \"prefix\": \"\",\n \"suffix\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "777a1179-85bb-43ec-b53f-4ae048fc0499", "name": "Accounting account created", "originalRequest": { "url": { "path": [ "api", "v2", "accounting-accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"account\": \"\",\n \"prefix\": \"\",\n \"suffix\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"account\": \"\",\n \"prefix\": \"\",\n \"suffix\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"rollupAccount\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5de252ff-48d6-464a-978f-8217ea1dd798", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "accounting-accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"account\": \"\",\n \"prefix\": \"\",\n \"suffix\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ed30e410-6b3c-473c-b93d-c24f4a776acd", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "accounting-accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"account\": \"\",\n \"prefix\": \"\",\n \"suffix\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "71f72f58-3388-42c9-9858-80d66066ce37", "name": "Authenticated user is missing the `CREAR_CUENTASCONTABLES` permission", "originalRequest": { "url": { "path": [ "api", "v2", "accounting-accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"account\": \"\",\n \"prefix\": \"\",\n \"suffix\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e5f5b312-5181-47ca-ad4f-dc86e5b79fa6", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "accounting-accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"account\": \"\",\n \"prefix\": \"\",\n \"suffix\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "new", "description": "", "item": [ { "id": "86feeab9-1e6a-4ac5-b98e-516b2ef3aff3", "name": "Prototype an accounting account for a creation form", "request": { "name": "Prototype an accounting account for a creation form", "description": { "content": "Non-persisted defaults: current company, enabled=true, blockType=null. Optional JSON hints: companyId, prefix, copyFromId.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "accounting-accounts", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "f4fc0dfd-df80-4a20-a632-8ff4b292f3cc", "name": "Accounting account prototype", "originalRequest": { "url": { "path": [ "api", "v2", "accounting-accounts", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"account\": \"\",\n \"prefix\": \"\",\n \"suffix\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"rollupAccount\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8181c2b0-980f-4eb3-9c2e-63b0a3a9b08f", "name": "Hint references an unknown entity", "originalRequest": { "url": { "path": [ "api", "v2", "accounting-accounts", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "051907f8-17dc-497c-bcbe-e38c0bc1c6e8", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "accounting-accounts", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "aadf8488-3003-41d8-a541-c866e2bc440c", "name": "Authenticated user is missing the `CREAR_CUENTASCONTABLES` permission", "originalRequest": { "url": { "path": [ "api", "v2", "accounting-accounts", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "91e9e489-6056-4866-ae3d-02c5b3810806", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "accounting-accounts", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "prefix-hints", "description": "", "item": [ { "id": "70508fbf-a1e4-4c8c-a717-854d216e9f61", "name": "List prefix hints while typing a new account code", "request": { "name": "List prefix hints while typing a new account code", "description": { "content": "Hierarchical chart-of-accounts hints mirroring the legacy JSF create dialog (`changeCuenta`). As each digit is typed, returns rollup accounts and sub-accounts whose prefix matches the typed hierarchy for the given company.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "accounting-accounts", "prefix-hints" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Account digits typed so far (numeric only)", "type": "text/plain" }, "key": "digits", "value": "" }, { "disabled": false, "description": { "content": "(Required) Owning company ID", "type": "text/plain" }, "key": "companyId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "5d0c6a28-b000-489b-abc9-8ecb3e1d20b5", "name": "Prefix hierarchy hints", "originalRequest": { "url": { "path": [ "api", "v2", "accounting-accounts", "prefix-hints" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Account digits typed so far (numeric only)", "type": "text/plain" }, "key": "digits", "value": "" }, { "disabled": false, "description": { "content": "(Required) Owning company ID", "type": "text/plain" }, "key": "companyId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"account\": \"\",\n \"prefix\": \"\",\n \"suffix\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"rollupAccount\": \"\",\n \"blockType\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4b281913-d299-42f6-b289-517827506b0a", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "accounting-accounts", "prefix-hints" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Account digits typed so far (numeric only)", "type": "text/plain" }, "key": "digits", "value": "" }, { "disabled": false, "description": { "content": "(Required) Owning company ID", "type": "text/plain" }, "key": "companyId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8c7c45c0-2203-48a1-a423-e277d3cbeb81", "name": "Authenticated user is missing the `VER_CUENTASCONTABLES` permission", "originalRequest": { "url": { "path": [ "api", "v2", "accounting-accounts", "prefix-hints" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Account digits typed so far (numeric only)", "type": "text/plain" }, "key": "digits", "value": "" }, { "disabled": false, "description": { "content": "(Required) Owning company ID", "type": "text/plain" }, "key": "companyId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6549b670-c7fb-4690-9da4-62e547482301", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "accounting-accounts", "prefix-hints" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Account digits typed so far (numeric only)", "type": "text/plain" }, "key": "digits", "value": "" }, { "disabled": false, "description": { "content": "(Required) Owning company ID", "type": "text/plain" }, "key": "companyId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "user-invitations", "description": "", "item": [ { "id": "cc8a0f99-51f2-4d9c-83fc-dac935e4f1df", "name": "List pending invitations", "request": { "name": "List pending invitations", "description": {}, "url": { "path": [ "api", "v2", "user-invitations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "71bc216d-ea79-4ce5-aeb0-38f69a0a1baf", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "user-invitations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "91054927-b41e-47f0-889c-cfb0008859fb", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "user-invitations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9173c634-a7d5-4ded-a08d-6ef7e485b118", "name": "Invite a user", "request": { "name": "Invite a user", "description": {}, "url": { "path": [ "api", "v2", "user-invitations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"roleId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"message\": \"\",\n \"branchAccess\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "bffc1ceb-03fd-45cd-a1b0-6a486528ac80", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "user-invitations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"roleId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"message\": \"\",\n \"branchAccess\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "febe6d7e-adef-4d0d-907f-290ee427b976", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "user-invitations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"roleId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"message\": \"\",\n \"branchAccess\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{id}", "description": "", "item": [ { "name": "resend", "description": "", "item": [ { "id": "5b6c73de-04d5-40b4-9dc3-6a976b54f88a", "name": "Resend a pending invitation", "request": { "name": "Resend a pending invitation", "description": {}, "url": { "path": [ "api", "v2", "user-invitations", ":id", "resend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "25f6b5c8-b6ae-451f-b7fd-099ff9469527", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "user-invitations", ":id", "resend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a4860cf6-2def-4c86-9d76-bb3dac5d882c", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "user-invitations", ":id", "resend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "0969b0a3-8c00-495d-b54b-0ea098f293fe", "name": "Cancel a pending invitation", "request": { "name": "Cancel a pending invitation", "description": {}, "url": { "path": [ "api", "v2", "user-invitations", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "50cb42b9-1888-426e-9b90-a7c0ef7a5ed6", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "user-invitations", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a7c74b50-02fd-4166-b3f2-6792a7dcf4c0", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "user-invitations", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "remittances", "description": "", "item": [ { "id": "572082bb-6fa5-4b36-9f29-52264300926b", "name": "List remittances", "request": { "name": "List remittances", "description": { "content": "Returns a paginated list of SEPA remittance headers.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "remittances" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "remittanceDate:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "4c46c00c-96c7-41c9-addb-512e0c265de6", "name": "Page of remittances", "originalRequest": { "url": { "path": [ "api", "v2", "remittances" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "remittanceDate:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "41312ec2-a66b-4494-b0df-512161be3c49", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "remittances" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "remittanceDate:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c3146375-d701-4231-8f83-ddbde9372021", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "remittances" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "remittanceDate:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b6f87eb0-dd29-4a99-999c-2f4b5553251d", "name": "Missing `VER_REMESA` permission", "originalRequest": { "url": { "path": [ "api", "v2", "remittances" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "remittanceDate:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ff4cc47c-349c-4a09-9eb2-2b860af5344f", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "remittances" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "remittanceDate:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "25b2e224-bdb7-450e-8925-e427c2415f3a", "name": "Create remittance", "request": { "name": "Create remittance", "description": { "content": "Creates a remittance from selected candidates and generates the pain.008 XML attachment.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "remittances" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Unique key for safely retrying this financial command", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"candidateDateFrom\": \"\",\n \"candidateDateTo\": \"\",\n \"companyId\": \"\",\n \"remittanceDate\": \"\",\n \"selectedCandidateKeys\": [\n \"\"\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"sepaXmlAttachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"sepaSignedXmlAttachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "b0d4caa5-0cee-4f15-a95f-228eb7a7d487", "name": "Remittance created", "originalRequest": { "url": { "path": [ "api", "v2", "remittances" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Unique key for safely retrying this financial command", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"candidateDateFrom\": \"\",\n \"candidateDateTo\": \"\",\n \"companyId\": \"\",\n \"remittanceDate\": \"\",\n \"selectedCandidateKeys\": [\n \"\"\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"sepaXmlAttachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"sepaSignedXmlAttachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"companyId\": \"\",\n \"remittanceDate\": \"\",\n \"id\": \"\",\n \"code\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"receiptCount\": \"\",\n \"total\": \"\",\n \"companyName\": \"\",\n \"sepaXmlAttachmentId\": \"\",\n \"sepaXmlAttachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"sepaSignedXmlAttachmentId\": \"\",\n \"sepaSignedXmlAttachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"lines\": [\n {\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"remittanceId\": \"\",\n \"originType\": \"F\",\n \"lineStatus\": \"D\",\n \"sepaFormat\": \"CORE\",\n \"amount\": \"\",\n \"concept\": \"\",\n \"endToEndId\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"counterpartyIban\": \"\",\n \"invoiceId\": \"\",\n \"invoiceCode\": \"\",\n \"installmentId\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n },\n {\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"remittanceId\": \"\",\n \"originType\": \"V\",\n \"lineStatus\": \"A\",\n \"sepaFormat\": \"CORE\",\n \"amount\": \"\",\n \"concept\": \"\",\n \"endToEndId\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"counterpartyIban\": \"\",\n \"invoiceId\": \"\",\n \"invoiceCode\": \"\",\n \"installmentId\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a02a221c-f241-4f12-adb6-85a7d9328e3c", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "remittances" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Unique key for safely retrying this financial command", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"candidateDateFrom\": \"\",\n \"candidateDateTo\": \"\",\n \"companyId\": \"\",\n \"remittanceDate\": \"\",\n \"selectedCandidateKeys\": [\n \"\"\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"sepaXmlAttachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"sepaSignedXmlAttachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a558c6a1-1e46-45ed-9d92-998d33a889e9", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "remittances" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Unique key for safely retrying this financial command", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"candidateDateFrom\": \"\",\n \"candidateDateTo\": \"\",\n \"companyId\": \"\",\n \"remittanceDate\": \"\",\n \"selectedCandidateKeys\": [\n \"\"\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"sepaXmlAttachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"sepaSignedXmlAttachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{id}", "description": "", "item": [ { "name": "signed-sepa-xml", "description": "", "item": [ { "id": "da070bb6-6df6-4c57-87b2-4c1438158852", "name": "Download signed SEPA XML", "request": { "name": "Download signed SEPA XML", "description": { "content": "Streams the bank-signed SEPA XML attachment when present.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "remittances", ":id", "signed-sepa-xml" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "8f42a2fc-6177-4369-b964-4a109cd6d7a8", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "remittances", ":id", "signed-sepa-xml" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b38e46be-4d72-4f3a-9603-8610afb9f62b", "name": "Remittance or signed XML attachment not found", "originalRequest": { "url": { "path": [ "api", "v2", "remittances", ":id", "signed-sepa-xml" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3f4aa208-1865-4ec4-890f-ab8684adf046", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "remittances", ":id", "signed-sepa-xml" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8209d91b-6525-472e-88e7-f67202c32d3b", "name": "Upload signed SEPA XML", "request": { "name": "Upload signed SEPA XML", "description": { "content": "Uploads the bank-signed XML file. Requires a generated SEPA XML to exist first.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "remittances", ":id", "signed-sepa-xml" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Signed XML file", "type": "text/plain" }, "key": "file", "type": "file" } ] }, "auth": null }, "response": [ { "id": "afa1f3a9-73f4-49ba-991a-a6a8d4bad117", "name": "Signed XML stored", "originalRequest": { "url": { "path": [ "api", "v2", "remittances", ":id", "signed-sepa-xml" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Signed XML file", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"companyId\": \"\",\n \"remittanceDate\": \"\",\n \"id\": \"\",\n \"code\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"receiptCount\": \"\",\n \"total\": \"\",\n \"companyName\": \"\",\n \"sepaXmlAttachmentId\": \"\",\n \"sepaXmlAttachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"sepaSignedXmlAttachmentId\": \"\",\n \"sepaSignedXmlAttachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"lines\": [\n {\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"remittanceId\": \"\",\n \"originType\": \"F\",\n \"lineStatus\": \"D\",\n \"sepaFormat\": \"CORE\",\n \"amount\": \"\",\n \"concept\": \"\",\n \"endToEndId\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"counterpartyIban\": \"\",\n \"invoiceId\": \"\",\n \"invoiceCode\": \"\",\n \"installmentId\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n },\n {\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"remittanceId\": \"\",\n \"originType\": \"V\",\n \"lineStatus\": \"A\",\n \"sepaFormat\": \"CORE\",\n \"amount\": \"\",\n \"concept\": \"\",\n \"endToEndId\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"counterpartyIban\": \"\",\n \"invoiceId\": \"\",\n \"invoiceCode\": \"\",\n \"installmentId\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "20f76ad5-29d0-4d5a-a6cf-935c1e26519e", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "remittances", ":id", "signed-sepa-xml" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Signed XML file", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4497bc06-6871-4d1c-99e7-15d76f36ab88", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "remittances", ":id", "signed-sepa-xml" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Signed XML file", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "actions", "description": "", "item": [ { "name": "regenerate-sepa-xml", "description": "", "item": [ { "id": "467cdc90-7c21-485c-9d87-7af81fc2ba58", "name": "Regenerate SEPA XML", "request": { "name": "Regenerate SEPA XML", "description": { "content": "Rebuilds the pain.008 XML attachment from the persisted lines. Support users only.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "remittances", ":id", "actions", "regenerate-sepa-xml" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "ba153ee5-d707-4365-bf0c-7006448d38a9", "name": "XML regenerated", "originalRequest": { "url": { "path": [ "api", "v2", "remittances", ":id", "actions", "regenerate-sepa-xml" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"companyId\": \"\",\n \"remittanceDate\": \"\",\n \"id\": \"\",\n \"code\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"receiptCount\": \"\",\n \"total\": \"\",\n \"companyName\": \"\",\n \"sepaXmlAttachmentId\": \"\",\n \"sepaXmlAttachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"sepaSignedXmlAttachmentId\": \"\",\n \"sepaSignedXmlAttachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"lines\": [\n {\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"remittanceId\": \"\",\n \"originType\": \"F\",\n \"lineStatus\": \"D\",\n \"sepaFormat\": \"CORE\",\n \"amount\": \"\",\n \"concept\": \"\",\n \"endToEndId\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"counterpartyIban\": \"\",\n \"invoiceId\": \"\",\n \"invoiceCode\": \"\",\n \"installmentId\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n },\n {\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"remittanceId\": \"\",\n \"originType\": \"V\",\n \"lineStatus\": \"A\",\n \"sepaFormat\": \"CORE\",\n \"amount\": \"\",\n \"concept\": \"\",\n \"endToEndId\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"counterpartyIban\": \"\",\n \"invoiceId\": \"\",\n \"invoiceCode\": \"\",\n \"installmentId\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3086c264-e8ff-40d3-a3ab-ec8e6a91e2f0", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "remittances", ":id", "actions", "regenerate-sepa-xml" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "91615b25-22a9-404b-8c67-fc4a0c17ffd2", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "remittances", ":id", "actions", "regenerate-sepa-xml" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "generate-payments", "description": "", "item": [ { "id": "bf606dcc-f67d-4927-9c74-248c856b4c38", "name": "Generate incoming payments", "request": { "name": "Generate incoming payments", "description": { "content": "Creates cobros for the selected remittance lines and marks them as C (paid).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "remittances", ":id", "actions", "generate-payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Unique key for safely retrying this financial command", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"lineIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "db137ef1-1bf5-4236-923b-ea25d7bab8fe", "name": "Payments generated", "originalRequest": { "url": { "path": [ "api", "v2", "remittances", ":id", "actions", "generate-payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Unique key for safely retrying this financial command", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"lineIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"companyId\": \"\",\n \"remittanceDate\": \"\",\n \"id\": \"\",\n \"code\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"receiptCount\": \"\",\n \"total\": \"\",\n \"companyName\": \"\",\n \"sepaXmlAttachmentId\": \"\",\n \"sepaXmlAttachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"sepaSignedXmlAttachmentId\": \"\",\n \"sepaSignedXmlAttachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"lines\": [\n {\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"remittanceId\": \"\",\n \"originType\": \"F\",\n \"lineStatus\": \"D\",\n \"sepaFormat\": \"CORE\",\n \"amount\": \"\",\n \"concept\": \"\",\n \"endToEndId\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"counterpartyIban\": \"\",\n \"invoiceId\": \"\",\n \"invoiceCode\": \"\",\n \"installmentId\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n },\n {\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"remittanceId\": \"\",\n \"originType\": \"V\",\n \"lineStatus\": \"A\",\n \"sepaFormat\": \"CORE\",\n \"amount\": \"\",\n \"concept\": \"\",\n \"endToEndId\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"counterpartyIban\": \"\",\n \"invoiceId\": \"\",\n \"invoiceCode\": \"\",\n \"installmentId\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8cd4e7dd-de6b-4753-b770-645ab253a7c3", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "remittances", ":id", "actions", "generate-payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Unique key for safely retrying this financial command", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"lineIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e84893f4-4436-4901-a60a-2247c818f58d", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "remittances", ":id", "actions", "generate-payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Unique key for safely retrying this financial command", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"lineIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "id": "9f90f656-dd5e-4345-bed7-e974e0e7b04e", "name": "Get remittance by ID", "request": { "name": "Get remittance by ID", "description": { "content": "Returns the remittance header, persisted lines and SEPA attachment metadata.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "remittances", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "a13676b7-368b-4eae-9fb3-3f8beecf8f3d", "name": "Remittance found", "originalRequest": { "url": { "path": [ "api", "v2", "remittances", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"companyId\": \"\",\n \"remittanceDate\": \"\",\n \"id\": \"\",\n \"code\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"receiptCount\": \"\",\n \"total\": \"\",\n \"companyName\": \"\",\n \"sepaXmlAttachmentId\": \"\",\n \"sepaXmlAttachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"sepaSignedXmlAttachmentId\": \"\",\n \"sepaSignedXmlAttachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"lines\": [\n {\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"remittanceId\": \"\",\n \"originType\": \"F\",\n \"lineStatus\": \"D\",\n \"sepaFormat\": \"CORE\",\n \"amount\": \"\",\n \"concept\": \"\",\n \"endToEndId\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"counterpartyIban\": \"\",\n \"invoiceId\": \"\",\n \"invoiceCode\": \"\",\n \"installmentId\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n },\n {\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"remittanceId\": \"\",\n \"originType\": \"V\",\n \"lineStatus\": \"A\",\n \"sepaFormat\": \"CORE\",\n \"amount\": \"\",\n \"concept\": \"\",\n \"endToEndId\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"counterpartyIban\": \"\",\n \"invoiceId\": \"\",\n \"invoiceCode\": \"\",\n \"installmentId\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9a0491f9-812b-404c-89c6-9153c777271a", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "remittances", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ec8fb3d3-a564-4af9-868d-57000f309cfc", "name": "Remittance not found", "originalRequest": { "url": { "path": [ "api", "v2", "remittances", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "41aad1a4-664b-42c3-8992-201b8d7959a7", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "remittances", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2bbb1c9c-0241-4540-88c9-cccd7ce814e3", "name": "Delete remittance", "request": { "name": "Delete remittance", "description": { "content": "Deletes a remittance when none of its lines are already paid. This legacy entity has no optimistic-lock version, so `If-Match` is not supported.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "remittances", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "1d8ee892-6149-42c1-9043-7efbbd357374", "name": "Remittance deleted", "originalRequest": { "url": { "path": [ "api", "v2", "remittances", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c95df704-f19e-4e6e-a444-28cec6242b9d", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "remittances", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b9f21f01-28ca-4041-a13c-b3f3a736d0a1", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "remittances", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0ca736a0-d174-4aa4-a95b-2e0422a89c9c", "name": "Merge-patch remittance", "request": { "name": "Merge-patch remittance", "description": { "content": "Updates mutable header fields only (`name`, `description`, `enabled`). Lines and remittance date are immutable. This legacy entity has no optimistic-lock version, so `If-Match` is not supported.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "remittances", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "787b1905-c3d8-4639-b0d4-d0235c0f5da3", "name": "Remittance updated", "originalRequest": { "url": { "path": [ "api", "v2", "remittances", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"companyId\": \"\",\n \"remittanceDate\": \"\",\n \"id\": \"\",\n \"code\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"receiptCount\": \"\",\n \"total\": \"\",\n \"companyName\": \"\",\n \"sepaXmlAttachmentId\": \"\",\n \"sepaXmlAttachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"sepaSignedXmlAttachmentId\": \"\",\n \"sepaSignedXmlAttachment\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mimeType\": \"\",\n \"sizeBytes\": \"\",\n \"downloadUrl\": \"\"\n },\n \"lines\": [\n {\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"remittanceId\": \"\",\n \"originType\": \"F\",\n \"lineStatus\": \"D\",\n \"sepaFormat\": \"CORE\",\n \"amount\": \"\",\n \"concept\": \"\",\n \"endToEndId\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"counterpartyIban\": \"\",\n \"invoiceId\": \"\",\n \"invoiceCode\": \"\",\n \"installmentId\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n },\n {\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"remittanceId\": \"\",\n \"originType\": \"V\",\n \"lineStatus\": \"A\",\n \"sepaFormat\": \"CORE\",\n \"amount\": \"\",\n \"concept\": \"\",\n \"endToEndId\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"counterpartyIban\": \"\",\n \"invoiceId\": \"\",\n \"invoiceCode\": \"\",\n \"installmentId\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3d4bfc2b-0852-4b86-a672-6120ef58a325", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "remittances", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "28c684ff-10aa-4f7a-a3db-ad8a172dd3c0", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "remittances", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/merge-patch+json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"array\": \"\",\n \"empty\": \"\",\n \"null\": \"\",\n \"float\": \"\",\n \"number\": \"\",\n \"string\": \"\",\n \"double\": \"\",\n \"object\": \"\",\n \"long\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"int\": \"\",\n \"textual\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"valueNode\": \"\",\n \"bigDecimal\": \"\",\n \"container\": \"\",\n \"nodeType\": \"MISSING\",\n \"integralNumber\": \"\",\n \"missingNode\": \"\",\n \"bigInteger\": \"\",\n \"floatingPointNumber\": \"\",\n \"embeddedValue\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "sepa-xml", "description": "", "item": [ { "id": "16ccfe4a-3bbd-43bf-ae9d-e6795cd3f7d0", "name": "Download generated SEPA XML", "request": { "name": "Download generated SEPA XML", "description": { "content": "Streams the generated pain.008 XML attachment.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "remittances", ":id", "sepa-xml" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "087f03a2-7905-4edf-b49e-d745fab80f2b", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "remittances", ":id", "sepa-xml" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bc1681ba-e055-49f9-add8-e68836daccd5", "name": "Remittance or XML attachment not found", "originalRequest": { "url": { "path": [ "api", "v2", "remittances", ":id", "sepa-xml" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b60c9a74-7a1f-4b85-a4fe-566db0fdefd1", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "remittances", ":id", "sepa-xml" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "candidates", "description": "", "item": [ { "id": "7b1e26fa-8298-4a55-8a8a-4439ee7dc31a", "name": "List remittance candidates", "request": { "name": "List remittance candidates", "description": { "content": "Pending invoice balances and unpaid installments eligible for a new remittance.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "remittances", "candidates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Owning company ID", "type": "text/plain" }, "key": "companyId", "value": "" }, { "disabled": false, "description": { "content": "(Required) Inclusive start date (yyyy-MM-dd)", "type": "text/plain" }, "key": "fromDate", "value": "" }, { "disabled": false, "description": { "content": "(Required) Inclusive end date (yyyy-MM-dd)", "type": "text/plain" }, "key": "toDate", "value": "" }, { "disabled": false, "description": { "content": "Optional debtor name contains filter", "type": "text/plain" }, "key": "counterpartyName", "value": "" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "858893d6-8cf4-4fd5-a612-070ca5ee3876", "name": "Candidate rows", "originalRequest": { "url": { "path": [ "api", "v2", "remittances", "candidates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Owning company ID", "type": "text/plain" }, "key": "companyId", "value": "" }, { "disabled": false, "description": { "content": "(Required) Inclusive start date (yyyy-MM-dd)", "type": "text/plain" }, "key": "fromDate", "value": "" }, { "disabled": false, "description": { "content": "(Required) Inclusive end date (yyyy-MM-dd)", "type": "text/plain" }, "key": "toDate", "value": "" }, { "disabled": false, "description": { "content": "Optional debtor name contains filter", "type": "text/plain" }, "key": "counterpartyName", "value": "" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "[\n {\n \"rowKey\": \"\",\n \"originType\": \"V\",\n \"invoiceId\": \"\",\n \"installmentId\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"counterpartyIban\": \"\",\n \"counterpartyBic\": \"\",\n \"sepaFormat\": \"CORE\",\n \"mandateSignedDate\": \"\",\n \"mandateReference\": \"\",\n \"signedDirectDebitOrderId\": \"\",\n \"amount\": \"\",\n \"baseDate\": \"\",\n \"concept\": \"\"\n },\n {\n \"rowKey\": \"\",\n \"originType\": \"F\",\n \"invoiceId\": \"\",\n \"installmentId\": \"\",\n \"counterpartyId\": \"\",\n \"counterpartyName\": \"\",\n \"counterpartyIban\": \"\",\n \"counterpartyBic\": \"\",\n \"sepaFormat\": \"CORE\",\n \"mandateSignedDate\": \"\",\n \"mandateReference\": \"\",\n \"signedDirectDebitOrderId\": \"\",\n \"amount\": \"\",\n \"baseDate\": \"\",\n \"concept\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c25665c1-67e5-46af-8f0e-3e7f29bf05ba", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "remittances", "candidates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Owning company ID", "type": "text/plain" }, "key": "companyId", "value": "" }, { "disabled": false, "description": { "content": "(Required) Inclusive start date (yyyy-MM-dd)", "type": "text/plain" }, "key": "fromDate", "value": "" }, { "disabled": false, "description": { "content": "(Required) Inclusive end date (yyyy-MM-dd)", "type": "text/plain" }, "key": "toDate", "value": "" }, { "disabled": false, "description": { "content": "Optional debtor name contains filter", "type": "text/plain" }, "key": "counterpartyName", "value": "" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "51545463-9c21-42a2-b5c1-718143247a63", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "remittances", "candidates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Owning company ID", "type": "text/plain" }, "key": "companyId", "value": "" }, { "disabled": false, "description": { "content": "(Required) Inclusive start date (yyyy-MM-dd)", "type": "text/plain" }, "key": "fromDate", "value": "" }, { "disabled": false, "description": { "content": "(Required) Inclusive end date (yyyy-MM-dd)", "type": "text/plain" }, "key": "toDate", "value": "" }, { "disabled": false, "description": { "content": "Optional debtor name contains filter", "type": "text/plain" }, "key": "counterpartyName", "value": "" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "product-variants", "description": "", "item": [ { "name": "search", "description": "", "item": [ { "id": "4511fedf-071f-4661-9bb8-8403db78935e", "name": "Search product variants (document-form panel)", "request": { "name": "Search product variants (document-form panel)", "description": { "content": "Contextual SKU search for document forms. Matches name, description, barcode and reference ('*' = wildcard; exact barcode/reference matches first), extended to supplier price references when the company enables it. Applies the legacy eligibility rules: enabled products with a visible model state, company scope widened to the consolidated group when it shares products, zero-price exclusion on Venezuelan fiscal printer companies and, on the sales side, branch product lines, stock availability and lens blocking. Each row carries the company's searchable custom fields and base price list prices; request includeColumns=true once per form session to get the panel column metadata. Read-only. Prices are informational: lines are created through POST /api/v2/pricing/preview.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "product-variants", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"branchId\": \"\",\n \"q\": \"\",\n \"barcode\": \"\",\n \"counterpartyId\": \"\",\n \"issued\": \"\",\n \"categoryViewType\": \"\",\n \"excludeLenses\": \"\",\n \"includeColumns\": \"\",\n \"skip\": \"\",\n \"limit\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "3f979f34-3b0b-4fc4-a03c-df87a5926f90", "name": "Matching variants", "originalRequest": { "url": { "path": [ "api", "v2", "product-variants", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"branchId\": \"\",\n \"q\": \"\",\n \"barcode\": \"\",\n \"counterpartyId\": \"\",\n \"issued\": \"\",\n \"categoryViewType\": \"\",\n \"excludeLenses\": \"\",\n \"includeColumns\": \"\",\n \"skip\": \"\",\n \"limit\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"barCode\": \"\",\n \"reference\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"categoryName\": \"\",\n \"brandName\": \"\",\n \"salePriceNet\": \"\",\n \"salePriceGross\": \"\",\n \"inventoriable\": \"\",\n \"stock\": {\n \"quantity\": \"\",\n \"reserved\": \"\",\n \"available\": \"\",\n \"withoutStock\": \"\"\n },\n \"customFields\": [\n {\n \"fieldId\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldId\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"basePrices\": [\n {\n \"priceListId\": \"\",\n \"priceListName\": \"\",\n \"price\": \"\",\n \"discountPct\": \"\",\n \"finalPrice\": \"\",\n \"taxIncluded\": \"\"\n },\n {\n \"priceListId\": \"\",\n \"priceListName\": \"\",\n \"price\": \"\",\n \"discountPct\": \"\",\n \"finalPrice\": \"\",\n \"taxIncluded\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"barCode\": \"\",\n \"reference\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"categoryName\": \"\",\n \"brandName\": \"\",\n \"salePriceNet\": \"\",\n \"salePriceGross\": \"\",\n \"inventoriable\": \"\",\n \"stock\": {\n \"quantity\": \"\",\n \"reserved\": \"\",\n \"available\": \"\",\n \"withoutStock\": \"\"\n },\n \"customFields\": [\n {\n \"fieldId\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldId\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"basePrices\": [\n {\n \"priceListId\": \"\",\n \"priceListName\": \"\",\n \"price\": \"\",\n \"discountPct\": \"\",\n \"finalPrice\": \"\",\n \"taxIncluded\": \"\"\n },\n {\n \"priceListId\": \"\",\n \"priceListName\": \"\",\n \"price\": \"\",\n \"discountPct\": \"\",\n \"finalPrice\": \"\",\n \"taxIncluded\": \"\"\n }\n ]\n }\n ],\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\",\n \"columns\": {\n \"customFields\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"basePriceLists\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"showBrand\": \"\",\n \"showCategory\": \"\",\n \"showStockMinusReserves\": \"\",\n \"searchBySupplierRef\": \"\",\n \"orderBy\": \"REF\"\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a4330d44-a808-47f9-a3ce-64cd3e6394a8", "name": "Invalid request (unknown branch, missing q/barcode, ...)", "originalRequest": { "url": { "path": [ "api", "v2", "product-variants", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"branchId\": \"\",\n \"q\": \"\",\n \"barcode\": \"\",\n \"counterpartyId\": \"\",\n \"issued\": \"\",\n \"categoryViewType\": \"\",\n \"excludeLenses\": \"\",\n \"includeColumns\": \"\",\n \"skip\": \"\",\n \"limit\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "63a908ee-27b4-49f2-91f8-cb687b5b5250", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "product-variants", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"branchId\": \"\",\n \"q\": \"\",\n \"barcode\": \"\",\n \"counterpartyId\": \"\",\n \"issued\": \"\",\n \"categoryViewType\": \"\",\n \"excludeLenses\": \"\",\n \"includeColumns\": \"\",\n \"skip\": \"\",\n \"limit\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "32852aad-1d48-4c39-aa30-4ecb92028564", "name": "Authenticated user cannot use the document forms nor view products", "originalRequest": { "url": { "path": [ "api", "v2", "product-variants", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"branchId\": \"\",\n \"q\": \"\",\n \"barcode\": \"\",\n \"counterpartyId\": \"\",\n \"issued\": \"\",\n \"categoryViewType\": \"\",\n \"excludeLenses\": \"\",\n \"includeColumns\": \"\",\n \"skip\": \"\",\n \"limit\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "eacd7b59-2f50-465c-8119-59c3ae8fa1fd", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "product-variants", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"branchId\": \"\",\n \"q\": \"\",\n \"barcode\": \"\",\n \"counterpartyId\": \"\",\n \"issued\": \"\",\n \"categoryViewType\": \"\",\n \"excludeLenses\": \"\",\n \"includeColumns\": \"\",\n \"skip\": \"\",\n \"limit\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "pricing", "description": "", "item": [ { "name": "preview", "description": "", "item": [ { "id": "f67e70f0-50d9-4552-bccf-0e28341cb553", "name": "Resolve sales prices", "request": { "name": "Resolve sales prices", "description": { "content": "Resolves, per product, the tax-excluded unit price (base price list or product sheet), the commercial discount (percentage, lineal amount or tax-included final price), the applied price rule and the applicable insurer conditions, against a document context (branch, customer, price lists, date, currency). Stateless: nothing is persisted and eligibility is re-enforced server-side on save. Items resolve by productId or barcode (single-request scanner flow); per-item failures are reported inline via errorCode without failing the batch. Combos that depend on other lines already present on the document are resolved at save time, not here.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "pricing", "preview" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"id\": \"\",\n \"barCode\": \"\",\n \"reference\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"categoryName\": \"\",\n \"brandName\": \"\",\n \"salePriceNet\": \"\",\n \"salePriceGross\": \"\",\n \"inventoriable\": \"\",\n \"stock\": {\n \"quantity\": \"\",\n \"reserved\": \"\",\n \"available\": \"\",\n \"withoutStock\": \"\"\n },\n \"customFields\": [\n {\n \"fieldId\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldId\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"basePrices\": [\n {\n \"priceListId\": \"\",\n \"priceListName\": \"\",\n \"price\": \"\",\n \"discountPct\": \"\",\n \"finalPrice\": \"\",\n \"taxIncluded\": \"\"\n },\n {\n \"priceListId\": \"\",\n \"priceListName\": \"\",\n \"price\": \"\",\n \"discountPct\": \"\",\n \"finalPrice\": \"\",\n \"taxIncluded\": \"\"\n }\n ]\n }\n ],\n \"warehouseId\": \"\",\n \"counterpartyId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"documentDate\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"insurerIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "2d94b9b1-3073-402d-8332-9b11060c38ab", "name": "Resolved prices", "originalRequest": { "url": { "path": [ "api", "v2", "pricing", "preview" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"id\": \"\",\n \"barCode\": \"\",\n \"reference\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"categoryName\": \"\",\n \"brandName\": \"\",\n \"salePriceNet\": \"\",\n \"salePriceGross\": \"\",\n \"inventoriable\": \"\",\n \"stock\": {\n \"quantity\": \"\",\n \"reserved\": \"\",\n \"available\": \"\",\n \"withoutStock\": \"\"\n },\n \"customFields\": [\n {\n \"fieldId\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldId\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"basePrices\": [\n {\n \"priceListId\": \"\",\n \"priceListName\": \"\",\n \"price\": \"\",\n \"discountPct\": \"\",\n \"finalPrice\": \"\",\n \"taxIncluded\": \"\"\n },\n {\n \"priceListId\": \"\",\n \"priceListName\": \"\",\n \"price\": \"\",\n \"discountPct\": \"\",\n \"finalPrice\": \"\",\n \"taxIncluded\": \"\"\n }\n ]\n }\n ],\n \"warehouseId\": \"\",\n \"counterpartyId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"documentDate\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"insurerIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"warehouseId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"currencyCode\": \"\",\n \"insurers\": [\n {\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"documentCap\": \"\"\n },\n {\n \"insurerId\": \"\",\n \"insurerName\": \"\",\n \"documentCap\": \"\"\n }\n ],\n \"items\": [\n {\n \"lineRef\": \"\",\n \"productId\": \"\",\n \"productName\": \"\",\n \"reference\": \"\",\n \"barcode\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatPct\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"finalUnitPriceTaxIncluded\": \"\",\n \"appliedPriceRule\": {\n \"id\": \"\",\n \"ruleType\": \"COMBO\",\n \"tariffId\": \"\",\n \"tariffName\": \"\",\n \"comboId\": \"\",\n \"comboName\": \"\",\n \"purchaseCondition\": \"\",\n \"purchaseConditionId\": \"\",\n \"discountConditionId\": \"\",\n \"discountValue\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ]\n },\n \"insurerConditions\": [\n {\n \"insurerId\": \"\",\n \"pct\": \"\",\n \"capTaxIncluded\": \"\"\n },\n {\n \"insurerId\": \"\",\n \"pct\": \"\",\n \"capTaxIncluded\": \"\"\n }\n ],\n \"errorCode\": \"PRODUCT_NOT_FOUND\",\n \"errorMessage\": \"\"\n },\n {\n \"lineRef\": \"\",\n \"productId\": \"\",\n \"productName\": \"\",\n \"reference\": \"\",\n \"barcode\": \"\",\n \"vatTypeId\": \"\",\n \"vatTypeName\": \"\",\n \"vatPct\": \"\",\n \"unitPrice\": \"\",\n \"discountPct\": \"\",\n \"discountAmount\": \"\",\n \"finalUnitPriceTaxIncluded\": \"\",\n \"appliedPriceRule\": {\n \"id\": \"\",\n \"ruleType\": \"COMBO\",\n \"tariffId\": \"\",\n \"tariffName\": \"\",\n \"comboId\": \"\",\n \"comboName\": \"\",\n \"purchaseCondition\": \"\",\n \"purchaseConditionId\": \"\",\n \"discountConditionId\": \"\",\n \"discountValue\": \"\",\n \"categoryIds\": [\n \"\",\n \"\"\n ]\n },\n \"insurerConditions\": [\n {\n \"insurerId\": \"\",\n \"pct\": \"\",\n \"capTaxIncluded\": \"\"\n },\n {\n \"insurerId\": \"\",\n \"pct\": \"\",\n \"capTaxIncluded\": \"\"\n }\n ],\n \"errorCode\": \"PRODUCT_NOT_FOUND\",\n \"errorMessage\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0c016821-81d0-4ee3-a156-ca8381eaad75", "name": "Invalid request (unknown warehouse/customer/price list, no items, ...)", "originalRequest": { "url": { "path": [ "api", "v2", "pricing", "preview" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"id\": \"\",\n \"barCode\": \"\",\n \"reference\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"categoryName\": \"\",\n \"brandName\": \"\",\n \"salePriceNet\": \"\",\n \"salePriceGross\": \"\",\n \"inventoriable\": \"\",\n \"stock\": {\n \"quantity\": \"\",\n \"reserved\": \"\",\n \"available\": \"\",\n \"withoutStock\": \"\"\n },\n \"customFields\": [\n {\n \"fieldId\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldId\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"basePrices\": [\n {\n \"priceListId\": \"\",\n \"priceListName\": \"\",\n \"price\": \"\",\n \"discountPct\": \"\",\n \"finalPrice\": \"\",\n \"taxIncluded\": \"\"\n },\n {\n \"priceListId\": \"\",\n \"priceListName\": \"\",\n \"price\": \"\",\n \"discountPct\": \"\",\n \"finalPrice\": \"\",\n \"taxIncluded\": \"\"\n }\n ]\n }\n ],\n \"warehouseId\": \"\",\n \"counterpartyId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"documentDate\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"insurerIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f3771432-541d-4669-ae19-8e639fd658bf", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "pricing", "preview" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"id\": \"\",\n \"barCode\": \"\",\n \"reference\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"categoryName\": \"\",\n \"brandName\": \"\",\n \"salePriceNet\": \"\",\n \"salePriceGross\": \"\",\n \"inventoriable\": \"\",\n \"stock\": {\n \"quantity\": \"\",\n \"reserved\": \"\",\n \"available\": \"\",\n \"withoutStock\": \"\"\n },\n \"customFields\": [\n {\n \"fieldId\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldId\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"basePrices\": [\n {\n \"priceListId\": \"\",\n \"priceListName\": \"\",\n \"price\": \"\",\n \"discountPct\": \"\",\n \"finalPrice\": \"\",\n \"taxIncluded\": \"\"\n },\n {\n \"priceListId\": \"\",\n \"priceListName\": \"\",\n \"price\": \"\",\n \"discountPct\": \"\",\n \"finalPrice\": \"\",\n \"taxIncluded\": \"\"\n }\n ]\n }\n ],\n \"warehouseId\": \"\",\n \"counterpartyId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"documentDate\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"insurerIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "824ce90a-6784-4bfb-9ff8-739127807110", "name": "Authenticated user cannot create or edit sales invoices", "originalRequest": { "url": { "path": [ "api", "v2", "pricing", "preview" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"id\": \"\",\n \"barCode\": \"\",\n \"reference\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"categoryName\": \"\",\n \"brandName\": \"\",\n \"salePriceNet\": \"\",\n \"salePriceGross\": \"\",\n \"inventoriable\": \"\",\n \"stock\": {\n \"quantity\": \"\",\n \"reserved\": \"\",\n \"available\": \"\",\n \"withoutStock\": \"\"\n },\n \"customFields\": [\n {\n \"fieldId\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldId\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"basePrices\": [\n {\n \"priceListId\": \"\",\n \"priceListName\": \"\",\n \"price\": \"\",\n \"discountPct\": \"\",\n \"finalPrice\": \"\",\n \"taxIncluded\": \"\"\n },\n {\n \"priceListId\": \"\",\n \"priceListName\": \"\",\n \"price\": \"\",\n \"discountPct\": \"\",\n \"finalPrice\": \"\",\n \"taxIncluded\": \"\"\n }\n ]\n }\n ],\n \"warehouseId\": \"\",\n \"counterpartyId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"documentDate\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"insurerIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0c742499-0630-4079-ac36-08d5739ee18b", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "pricing", "preview" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"id\": \"\",\n \"barCode\": \"\",\n \"reference\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"categoryName\": \"\",\n \"brandName\": \"\",\n \"salePriceNet\": \"\",\n \"salePriceGross\": \"\",\n \"inventoriable\": \"\",\n \"stock\": {\n \"quantity\": \"\",\n \"reserved\": \"\",\n \"available\": \"\",\n \"withoutStock\": \"\"\n },\n \"customFields\": [\n {\n \"fieldId\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldId\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"basePrices\": [\n {\n \"priceListId\": \"\",\n \"priceListName\": \"\",\n \"price\": \"\",\n \"discountPct\": \"\",\n \"finalPrice\": \"\",\n \"taxIncluded\": \"\"\n },\n {\n \"priceListId\": \"\",\n \"priceListName\": \"\",\n \"price\": \"\",\n \"discountPct\": \"\",\n \"finalPrice\": \"\",\n \"taxIncluded\": \"\"\n }\n ]\n }\n ],\n \"warehouseId\": \"\",\n \"counterpartyId\": \"\",\n \"basePriceListId\": \"\",\n \"discountPriceListId\": \"\",\n \"documentDate\": \"\",\n \"currencyCode\": \"\",\n \"exchangeRate\": \"\",\n \"excludedTariffIds\": [\n \"\",\n \"\"\n ],\n \"insurerIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "label-batches", "description": "", "item": [ { "name": "render", "description": "", "item": [ { "id": "b017cf8d-130c-40de-bb61-588d477986b0", "name": "Render a label batch", "request": { "name": "Render a label batch", "description": { "content": "Renders the (edited) lines to a print job. With `Accept: application/json` (default) returns a `LabelPrintJobDocument` with the content base64-encoded (PDF or Zebra ZPL) plus `pageCount`, suitable for download, preview or QZ Tray. With `Accept: application/pdf` streams the raw PDF bytes inline (PDF formats only).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "label-batches", "render" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"formatCode\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"barcode\": \"\",\n \"description\": \"\",\n \"priceOriginal\": \"\",\n \"priceFinal\": \"\",\n \"freeFooter\": \"\",\n \"copies\": \"\"\n },\n {\n \"productId\": \"\",\n \"barcode\": \"\",\n \"description\": \"\",\n \"priceOriginal\": \"\",\n \"priceFinal\": \"\",\n \"freeFooter\": \"\",\n \"copies\": \"\"\n }\n ],\n \"printPaper\": \"A4\",\n \"blankSpaces\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "06574b9f-85df-42ac-8a4b-4ef227031df7", "name": "Rendered print job", "originalRequest": { "url": { "path": [ "api", "v2", "label-batches", "render" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"formatCode\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"barcode\": \"\",\n \"description\": \"\",\n \"priceOriginal\": \"\",\n \"priceFinal\": \"\",\n \"freeFooter\": \"\",\n \"copies\": \"\"\n },\n {\n \"productId\": \"\",\n \"barcode\": \"\",\n \"description\": \"\",\n \"priceOriginal\": \"\",\n \"priceFinal\": \"\",\n \"freeFooter\": \"\",\n \"copies\": \"\"\n }\n ],\n \"printPaper\": \"A4\",\n \"blankSpaces\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"medium\": \"PDF\",\n \"mimeType\": \"\",\n \"filename\": \"\",\n \"contentBase64\": \"\",\n \"pageCount\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de2ad7b2-219c-442e-9cd3-915c71e53ade", "name": "Invalid request (unknown format, empty lines, ...)", "originalRequest": { "url": { "path": [ "api", "v2", "label-batches", "render" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"formatCode\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"barcode\": \"\",\n \"description\": \"\",\n \"priceOriginal\": \"\",\n \"priceFinal\": \"\",\n \"freeFooter\": \"\",\n \"copies\": \"\"\n },\n {\n \"productId\": \"\",\n \"barcode\": \"\",\n \"description\": \"\",\n \"priceOriginal\": \"\",\n \"priceFinal\": \"\",\n \"freeFooter\": \"\",\n \"copies\": \"\"\n }\n ],\n \"printPaper\": \"A4\",\n \"blankSpaces\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8a6d9c8-2e05-46fa-81b2-170c9aac388b", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "label-batches", "render" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"formatCode\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"barcode\": \"\",\n \"description\": \"\",\n \"priceOriginal\": \"\",\n \"priceFinal\": \"\",\n \"freeFooter\": \"\",\n \"copies\": \"\"\n },\n {\n \"productId\": \"\",\n \"barcode\": \"\",\n \"description\": \"\",\n \"priceOriginal\": \"\",\n \"priceFinal\": \"\",\n \"freeFooter\": \"\",\n \"copies\": \"\"\n }\n ],\n \"printPaper\": \"A4\",\n \"blankSpaces\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8134b4b4-fbc8-441d-911a-bc242d67a32a", "name": "Authenticated user is missing the `CREAR_ETIQUETAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "label-batches", "render" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"formatCode\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"barcode\": \"\",\n \"description\": \"\",\n \"priceOriginal\": \"\",\n \"priceFinal\": \"\",\n \"freeFooter\": \"\",\n \"copies\": \"\"\n },\n {\n \"productId\": \"\",\n \"barcode\": \"\",\n \"description\": \"\",\n \"priceOriginal\": \"\",\n \"priceFinal\": \"\",\n \"freeFooter\": \"\",\n \"copies\": \"\"\n }\n ],\n \"printPaper\": \"A4\",\n \"blankSpaces\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "978edcb2-7b59-4243-8900-f8119f78c309", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "label-batches", "render" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"formatCode\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"barcode\": \"\",\n \"description\": \"\",\n \"priceOriginal\": \"\",\n \"priceFinal\": \"\",\n \"freeFooter\": \"\",\n \"copies\": \"\"\n },\n {\n \"productId\": \"\",\n \"barcode\": \"\",\n \"description\": \"\",\n \"priceOriginal\": \"\",\n \"priceFinal\": \"\",\n \"freeFooter\": \"\",\n \"copies\": \"\"\n }\n ],\n \"printPaper\": \"A4\",\n \"blankSpaces\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "preview", "description": "", "item": [ { "id": "cf3039b6-448d-4169-a605-07c19a3e6cae", "name": "Resolve label prices", "request": { "name": "Resolve label prices", "description": { "content": "Resolves barcode, description and prices (base price, discount, VAT and commercial rounding) for a set of products against a format, a base price list and a branch. Returns the priced lines to render the \"Detalles de las etiquetas\" table and the per-label preview.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "label-batches", "preview" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"formatCode\": \"\",\n \"items\": [\n {\n \"id\": \"\",\n \"barCode\": \"\",\n \"reference\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"categoryName\": \"\",\n \"brandName\": \"\",\n \"salePriceNet\": \"\",\n \"salePriceGross\": \"\",\n \"inventoriable\": \"\",\n \"stock\": {\n \"quantity\": \"\",\n \"reserved\": \"\",\n \"available\": \"\",\n \"withoutStock\": \"\"\n },\n \"customFields\": [\n {\n \"fieldId\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldId\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"basePrices\": [\n {\n \"priceListId\": \"\",\n \"priceListName\": \"\",\n \"price\": \"\",\n \"discountPct\": \"\",\n \"finalPrice\": \"\",\n \"taxIncluded\": \"\"\n },\n {\n \"priceListId\": \"\",\n \"priceListName\": \"\",\n \"price\": \"\",\n \"discountPct\": \"\",\n \"finalPrice\": \"\",\n \"taxIncluded\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"barCode\": \"\",\n \"reference\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"categoryName\": \"\",\n \"brandName\": \"\",\n \"salePriceNet\": \"\",\n \"salePriceGross\": \"\",\n \"inventoriable\": \"\",\n \"stock\": {\n \"quantity\": \"\",\n \"reserved\": \"\",\n \"available\": \"\",\n \"withoutStock\": \"\"\n },\n \"customFields\": [\n {\n \"fieldId\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldId\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"basePrices\": [\n {\n \"priceListId\": \"\",\n \"priceListName\": \"\",\n \"price\": \"\",\n \"discountPct\": \"\",\n \"finalPrice\": \"\",\n \"taxIncluded\": \"\"\n },\n {\n \"priceListId\": \"\",\n \"priceListName\": \"\",\n \"price\": \"\",\n \"discountPct\": \"\",\n \"finalPrice\": \"\",\n \"taxIncluded\": \"\"\n }\n ]\n }\n ],\n \"warehouseId\": \"\",\n \"basePriceListId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "b6b63822-c67e-40da-94c8-c2cad9a4625c", "name": "Resolved label batch", "originalRequest": { "url": { "path": [ "api", "v2", "label-batches", "preview" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"formatCode\": \"\",\n \"items\": [\n {\n \"id\": \"\",\n \"barCode\": \"\",\n \"reference\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"categoryName\": \"\",\n \"brandName\": \"\",\n \"salePriceNet\": \"\",\n \"salePriceGross\": \"\",\n \"inventoriable\": \"\",\n \"stock\": {\n \"quantity\": \"\",\n \"reserved\": \"\",\n \"available\": \"\",\n \"withoutStock\": \"\"\n },\n \"customFields\": [\n {\n \"fieldId\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldId\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"basePrices\": [\n {\n \"priceListId\": \"\",\n \"priceListName\": \"\",\n \"price\": \"\",\n \"discountPct\": \"\",\n \"finalPrice\": \"\",\n \"taxIncluded\": \"\"\n },\n {\n \"priceListId\": \"\",\n \"priceListName\": \"\",\n \"price\": \"\",\n \"discountPct\": \"\",\n \"finalPrice\": \"\",\n \"taxIncluded\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"barCode\": \"\",\n \"reference\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"categoryName\": \"\",\n \"brandName\": \"\",\n \"salePriceNet\": \"\",\n \"salePriceGross\": \"\",\n \"inventoriable\": \"\",\n \"stock\": {\n \"quantity\": \"\",\n \"reserved\": \"\",\n \"available\": \"\",\n \"withoutStock\": \"\"\n },\n \"customFields\": [\n {\n \"fieldId\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldId\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"basePrices\": [\n {\n \"priceListId\": \"\",\n \"priceListName\": \"\",\n \"price\": \"\",\n \"discountPct\": \"\",\n \"finalPrice\": \"\",\n \"taxIncluded\": \"\"\n },\n {\n \"priceListId\": \"\",\n \"priceListName\": \"\",\n \"price\": \"\",\n \"discountPct\": \"\",\n \"finalPrice\": \"\",\n \"taxIncluded\": \"\"\n }\n ]\n }\n ],\n \"warehouseId\": \"\",\n \"basePriceListId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"formatCode\": \"\",\n \"basePriceListId\": \"\",\n \"warehouseId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"barcode\": \"\",\n \"productName\": \"\",\n \"description\": \"\",\n \"priceOriginal\": \"\",\n \"priceFinal\": \"\",\n \"discounted\": \"\",\n \"freeFooter\": \"\",\n \"copies\": \"\"\n },\n {\n \"productId\": \"\",\n \"barcode\": \"\",\n \"productName\": \"\",\n \"description\": \"\",\n \"priceOriginal\": \"\",\n \"priceFinal\": \"\",\n \"discounted\": \"\",\n \"freeFooter\": \"\",\n \"copies\": \"\"\n }\n ],\n \"defaultCopies\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "670edfaa-1432-459a-8e2e-a3e8c587d920", "name": "Invalid request (unknown format, missing branch, ...)", "originalRequest": { "url": { "path": [ "api", "v2", "label-batches", "preview" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"formatCode\": \"\",\n \"items\": [\n {\n \"id\": \"\",\n \"barCode\": \"\",\n \"reference\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"categoryName\": \"\",\n \"brandName\": \"\",\n \"salePriceNet\": \"\",\n \"salePriceGross\": \"\",\n \"inventoriable\": \"\",\n \"stock\": {\n \"quantity\": \"\",\n \"reserved\": \"\",\n \"available\": \"\",\n \"withoutStock\": \"\"\n },\n \"customFields\": [\n {\n \"fieldId\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldId\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"basePrices\": [\n {\n \"priceListId\": \"\",\n \"priceListName\": \"\",\n \"price\": \"\",\n \"discountPct\": \"\",\n \"finalPrice\": \"\",\n \"taxIncluded\": \"\"\n },\n {\n \"priceListId\": \"\",\n \"priceListName\": \"\",\n \"price\": \"\",\n \"discountPct\": \"\",\n \"finalPrice\": \"\",\n \"taxIncluded\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"barCode\": \"\",\n \"reference\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"categoryName\": \"\",\n \"brandName\": \"\",\n \"salePriceNet\": \"\",\n \"salePriceGross\": \"\",\n \"inventoriable\": \"\",\n \"stock\": {\n \"quantity\": \"\",\n \"reserved\": \"\",\n \"available\": \"\",\n \"withoutStock\": \"\"\n },\n \"customFields\": [\n {\n \"fieldId\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldId\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"basePrices\": [\n {\n \"priceListId\": \"\",\n \"priceListName\": \"\",\n \"price\": \"\",\n \"discountPct\": \"\",\n \"finalPrice\": \"\",\n \"taxIncluded\": \"\"\n },\n {\n \"priceListId\": \"\",\n \"priceListName\": \"\",\n \"price\": \"\",\n \"discountPct\": \"\",\n \"finalPrice\": \"\",\n \"taxIncluded\": \"\"\n }\n ]\n }\n ],\n \"warehouseId\": \"\",\n \"basePriceListId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "276bc6b4-6d9c-45e5-8099-0dd21dc277bb", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "label-batches", "preview" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"formatCode\": \"\",\n \"items\": [\n {\n \"id\": \"\",\n \"barCode\": \"\",\n \"reference\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"categoryName\": \"\",\n \"brandName\": \"\",\n \"salePriceNet\": \"\",\n \"salePriceGross\": \"\",\n \"inventoriable\": \"\",\n \"stock\": {\n \"quantity\": \"\",\n \"reserved\": \"\",\n \"available\": \"\",\n \"withoutStock\": \"\"\n },\n \"customFields\": [\n {\n \"fieldId\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldId\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"basePrices\": [\n {\n \"priceListId\": \"\",\n \"priceListName\": \"\",\n \"price\": \"\",\n \"discountPct\": \"\",\n \"finalPrice\": \"\",\n \"taxIncluded\": \"\"\n },\n {\n \"priceListId\": \"\",\n \"priceListName\": \"\",\n \"price\": \"\",\n \"discountPct\": \"\",\n \"finalPrice\": \"\",\n \"taxIncluded\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"barCode\": \"\",\n \"reference\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"categoryName\": \"\",\n \"brandName\": \"\",\n \"salePriceNet\": \"\",\n \"salePriceGross\": \"\",\n \"inventoriable\": \"\",\n \"stock\": {\n \"quantity\": \"\",\n \"reserved\": \"\",\n \"available\": \"\",\n \"withoutStock\": \"\"\n },\n \"customFields\": [\n {\n \"fieldId\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldId\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"basePrices\": [\n {\n \"priceListId\": \"\",\n \"priceListName\": \"\",\n \"price\": \"\",\n \"discountPct\": \"\",\n \"finalPrice\": \"\",\n \"taxIncluded\": \"\"\n },\n {\n \"priceListId\": \"\",\n \"priceListName\": \"\",\n \"price\": \"\",\n \"discountPct\": \"\",\n \"finalPrice\": \"\",\n \"taxIncluded\": \"\"\n }\n ]\n }\n ],\n \"warehouseId\": \"\",\n \"basePriceListId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b6e24d15-54f2-4b99-a8bc-08a8d1603bfe", "name": "Authenticated user is missing the `CREAR_ETIQUETAS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "label-batches", "preview" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"formatCode\": \"\",\n \"items\": [\n {\n \"id\": \"\",\n \"barCode\": \"\",\n \"reference\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"categoryName\": \"\",\n \"brandName\": \"\",\n \"salePriceNet\": \"\",\n \"salePriceGross\": \"\",\n \"inventoriable\": \"\",\n \"stock\": {\n \"quantity\": \"\",\n \"reserved\": \"\",\n \"available\": \"\",\n \"withoutStock\": \"\"\n },\n \"customFields\": [\n {\n \"fieldId\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldId\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"basePrices\": [\n {\n \"priceListId\": \"\",\n \"priceListName\": \"\",\n \"price\": \"\",\n \"discountPct\": \"\",\n \"finalPrice\": \"\",\n \"taxIncluded\": \"\"\n },\n {\n \"priceListId\": \"\",\n \"priceListName\": \"\",\n \"price\": \"\",\n \"discountPct\": \"\",\n \"finalPrice\": \"\",\n \"taxIncluded\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"barCode\": \"\",\n \"reference\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"categoryName\": \"\",\n \"brandName\": \"\",\n \"salePriceNet\": \"\",\n \"salePriceGross\": \"\",\n \"inventoriable\": \"\",\n \"stock\": {\n \"quantity\": \"\",\n \"reserved\": \"\",\n \"available\": \"\",\n \"withoutStock\": \"\"\n },\n \"customFields\": [\n {\n \"fieldId\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldId\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"basePrices\": [\n {\n \"priceListId\": \"\",\n \"priceListName\": \"\",\n \"price\": \"\",\n \"discountPct\": \"\",\n \"finalPrice\": \"\",\n \"taxIncluded\": \"\"\n },\n {\n \"priceListId\": \"\",\n \"priceListName\": \"\",\n \"price\": \"\",\n \"discountPct\": \"\",\n \"finalPrice\": \"\",\n \"taxIncluded\": \"\"\n }\n ]\n }\n ],\n \"warehouseId\": \"\",\n \"basePriceListId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "db83baa3-37ac-46e9-a9ab-0f49a605b5e4", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "label-batches", "preview" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"formatCode\": \"\",\n \"items\": [\n {\n \"id\": \"\",\n \"barCode\": \"\",\n \"reference\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"categoryName\": \"\",\n \"brandName\": \"\",\n \"salePriceNet\": \"\",\n \"salePriceGross\": \"\",\n \"inventoriable\": \"\",\n \"stock\": {\n \"quantity\": \"\",\n \"reserved\": \"\",\n \"available\": \"\",\n \"withoutStock\": \"\"\n },\n \"customFields\": [\n {\n \"fieldId\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldId\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"basePrices\": [\n {\n \"priceListId\": \"\",\n \"priceListName\": \"\",\n \"price\": \"\",\n \"discountPct\": \"\",\n \"finalPrice\": \"\",\n \"taxIncluded\": \"\"\n },\n {\n \"priceListId\": \"\",\n \"priceListName\": \"\",\n \"price\": \"\",\n \"discountPct\": \"\",\n \"finalPrice\": \"\",\n \"taxIncluded\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"barCode\": \"\",\n \"reference\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"categoryName\": \"\",\n \"brandName\": \"\",\n \"salePriceNet\": \"\",\n \"salePriceGross\": \"\",\n \"inventoriable\": \"\",\n \"stock\": {\n \"quantity\": \"\",\n \"reserved\": \"\",\n \"available\": \"\",\n \"withoutStock\": \"\"\n },\n \"customFields\": [\n {\n \"fieldId\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldId\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"basePrices\": [\n {\n \"priceListId\": \"\",\n \"priceListName\": \"\",\n \"price\": \"\",\n \"discountPct\": \"\",\n \"finalPrice\": \"\",\n \"taxIncluded\": \"\"\n },\n {\n \"priceListId\": \"\",\n \"priceListName\": \"\",\n \"price\": \"\",\n \"discountPct\": \"\",\n \"finalPrice\": \"\",\n \"taxIncluded\": \"\"\n }\n ]\n }\n ],\n \"warehouseId\": \"\",\n \"basePriceListId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "inventory-exits", "description": "", "item": [ { "id": "84931278-e73d-4f5c-8e77-4587579b5657", "name": "List inventory exits", "request": { "name": "List inventory exits", "description": { "content": "Returns a paginated list of manual inventory exits (stock adjustments with `tipoDoc = SAL_MAN`). Supports RSQL filtering, sorting, `skip`/`limit` pagination and `modifiedAfter`/`modifiedBefore` bookends.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "inventory-exits" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "documentDate:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "156eb49a-3dc2-4807-8151-d56df65c5370", "name": "Page of inventory exits", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-exits" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "documentDate:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d60b6e94-993e-4e39-b933-b26ddbf869e1", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-exits" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "documentDate:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d04a0fb3-7ce7-4ee9-974d-938a67b9a4ec", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-exits" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "documentDate:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9e6d8f31-da6b-4429-9386-d1f54638a97c", "name": "Authenticated user is missing the `VER_TRASPASOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-exits" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "documentDate:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e8658c94-46fc-41a2-a4e0-f7b0ecda7e74", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-exits" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "documentDate:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "91837b52-1105-44b7-932d-d68610610a53", "name": "Create inventory exit", "request": { "name": "Create inventory exit", "description": { "content": "Creates a manual inventory exit. The line quantities are subtracted from the source warehouse stock immediately upon successful creation. Business logic runs in the legacy WAR via the internal commands gateway.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "inventory-exits" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"warehouseId\": \"\",\n \"documentDate\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"trackingCode\": \"\",\n \"adjustmentReasonId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"unitCost\": \"\",\n \"notes\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"unitCost\": \"\",\n \"notes\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "9acb3482-cffd-4cff-8f4f-53d8da36686c", "name": "Inventory exit created", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-exits" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"warehouseId\": \"\",\n \"documentDate\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"trackingCode\": \"\",\n \"adjustmentReasonId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"unitCost\": \"\",\n \"notes\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"unitCost\": \"\",\n \"notes\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"documentDate\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"trackingCode\": \"\",\n \"adjustmentReasonId\": \"\",\n \"adjustmentReasonName\": \"\",\n \"totalQuantity\": \"\",\n \"totalCost\": \"\",\n \"lines\": [\n {\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productId\": \"\",\n \"productName\": \"\",\n \"productSku\": \"\",\n \"quantity\": \"\",\n \"unitCost\": \"\",\n \"totalCost\": \"\",\n \"notes\": \"\"\n },\n {\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productId\": \"\",\n \"productName\": \"\",\n \"productSku\": \"\",\n \"quantity\": \"\",\n \"unitCost\": \"\",\n \"totalCost\": \"\",\n \"notes\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "02d1aed2-ee4c-4589-901d-803440f124ca", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-exits" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"warehouseId\": \"\",\n \"documentDate\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"trackingCode\": \"\",\n \"adjustmentReasonId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"unitCost\": \"\",\n \"notes\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"unitCost\": \"\",\n \"notes\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9274d98c-883c-4429-81f2-e99798f09283", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-exits" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"warehouseId\": \"\",\n \"documentDate\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"trackingCode\": \"\",\n \"adjustmentReasonId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"unitCost\": \"\",\n \"notes\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"unitCost\": \"\",\n \"notes\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "055f12e6-b87e-4653-8a6c-47fd26a7e091", "name": "Authenticated user is missing the `CREAR_TRASPASOSDIRECTOS` permission, or the `warehouseId` is outside the user's branch scope", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-exits" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"warehouseId\": \"\",\n \"documentDate\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"trackingCode\": \"\",\n \"adjustmentReasonId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"unitCost\": \"\",\n \"notes\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"unitCost\": \"\",\n \"notes\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "18ab111c-3a8a-4957-9fc5-841b2b708995", "name": "Operation would leave a product with negative stock", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-exits" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"warehouseId\": \"\",\n \"documentDate\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"trackingCode\": \"\",\n \"adjustmentReasonId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"unitCost\": \"\",\n \"notes\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"unitCost\": \"\",\n \"notes\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b9dcdfb4-6e3a-4251-bf7d-53ed72bd79a8", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-exits" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"warehouseId\": \"\",\n \"documentDate\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"trackingCode\": \"\",\n \"adjustmentReasonId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"unitCost\": \"\",\n \"notes\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"unitCost\": \"\",\n \"notes\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{id}", "description": "", "item": [ { "id": "d61355ca-3190-4c22-927f-5b7ca656e822", "name": "Get inventory exit by ID", "request": { "name": "Get inventory exit by ID", "description": { "content": "Returns a single inventory exit including its `lines`. The response carries a strong `ETag` header with the current version.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "inventory-exits", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Inventory exit ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "7386cecb-19c4-4dd5-8e8c-c6d3bcd04b0e", "name": "Inventory exit found", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-exits", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inventory exit ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"documentDate\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"trackingCode\": \"\",\n \"adjustmentReasonId\": \"\",\n \"adjustmentReasonName\": \"\",\n \"totalQuantity\": \"\",\n \"totalCost\": \"\",\n \"lines\": [\n {\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productId\": \"\",\n \"productName\": \"\",\n \"productSku\": \"\",\n \"quantity\": \"\",\n \"unitCost\": \"\",\n \"totalCost\": \"\",\n \"notes\": \"\"\n },\n {\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productId\": \"\",\n \"productName\": \"\",\n \"productSku\": \"\",\n \"quantity\": \"\",\n \"unitCost\": \"\",\n \"totalCost\": \"\",\n \"notes\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "edc90f3d-5fbd-4e56-82d9-a0f0f03ebb07", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-exits", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inventory exit ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e21280cb-174a-44aa-841c-ea4a3987bd52", "name": "Authenticated user is missing the `VER_TRASPASOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-exits", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inventory exit ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7c4b09da-ecf2-4354-9033-0d72098ccab3", "name": "Inventory exit not found", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-exits", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inventory exit ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5f06f3cb-ace3-43fa-a125-99d5c4bc3ccc", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-exits", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inventory exit ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "inventory-entries", "description": "", "item": [ { "id": "3428d0f6-eb42-4a3d-a3a6-45976df90f82", "name": "List inventory entries", "request": { "name": "List inventory entries", "description": { "content": "Returns a paginated list of manual inventory entries (stock adjustments with `tipoDoc = ENT_MAN`). Supports RSQL filtering, sorting, `skip`/`limit` pagination and `modifiedAfter`/`modifiedBefore` bookends.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "inventory-entries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "documentDate:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "1b571154-bfc0-4719-8fb9-401716bbbe05", "name": "Page of inventory entries", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-entries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "documentDate:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "412d79cc-544d-47c5-b1b3-a500b62609c5", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-entries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "documentDate:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2c8fb835-4755-48d5-b3d2-b255a51b1b85", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-entries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "documentDate:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8e37d133-21f1-48cf-9184-333114f359de", "name": "Authenticated user is missing the `VER_TRASPASOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-entries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "documentDate:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f78437bd-76f3-4119-b3fc-54bc7a9a20c4", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-entries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "documentDate:desc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c3b80195-6cdf-42a2-aa87-15a27857ce74", "name": "Create inventory entry", "request": { "name": "Create inventory entry", "description": { "content": "Creates a manual inventory entry. The line quantities are added to the destination warehouse stock immediately upon successful creation. Business logic runs in the legacy WAR via the internal commands gateway.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "inventory-entries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"warehouseId\": \"\",\n \"documentDate\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"trackingCode\": \"\",\n \"adjustmentReasonId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"unitCost\": \"\",\n \"notes\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"unitCost\": \"\",\n \"notes\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "7f3b1588-1342-44d8-a865-6edab8bbdab4", "name": "Inventory entry created", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-entries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"warehouseId\": \"\",\n \"documentDate\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"trackingCode\": \"\",\n \"adjustmentReasonId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"unitCost\": \"\",\n \"notes\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"unitCost\": \"\",\n \"notes\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"documentDate\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"trackingCode\": \"\",\n \"adjustmentReasonId\": \"\",\n \"adjustmentReasonName\": \"\",\n \"totalQuantity\": \"\",\n \"totalCost\": \"\",\n \"lines\": [\n {\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productId\": \"\",\n \"productName\": \"\",\n \"productSku\": \"\",\n \"quantity\": \"\",\n \"unitCost\": \"\",\n \"totalCost\": \"\",\n \"notes\": \"\"\n },\n {\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productId\": \"\",\n \"productName\": \"\",\n \"productSku\": \"\",\n \"quantity\": \"\",\n \"unitCost\": \"\",\n \"totalCost\": \"\",\n \"notes\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b5b6258f-7331-4f00-b205-c131dc5284f2", "name": "Validation error ÔÇö the request body or a query parameter failed constraint validation. The response payload includes a `errors` array with field-level details.", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-entries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"warehouseId\": \"\",\n \"documentDate\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"trackingCode\": \"\",\n \"adjustmentReasonId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"unitCost\": \"\",\n \"notes\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"unitCost\": \"\",\n \"notes\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c1baacab-af68-45e0-aee3-0e4a7ba850c9", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-entries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"warehouseId\": \"\",\n \"documentDate\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"trackingCode\": \"\",\n \"adjustmentReasonId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"unitCost\": \"\",\n \"notes\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"unitCost\": \"\",\n \"notes\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2184d75b-f99a-4ee4-8966-d3c1a3b46a85", "name": "Authenticated user is missing the `CREAR_TRASPASOSDIRECTOS` permission, or the `warehouseId` is outside the user's branch scope", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-entries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"warehouseId\": \"\",\n \"documentDate\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"trackingCode\": \"\",\n \"adjustmentReasonId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"unitCost\": \"\",\n \"notes\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"unitCost\": \"\",\n \"notes\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "33d81997-66ae-4970-9d4f-db6ec808bdc4", "name": "Operation would leave a product with negative stock", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-entries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"warehouseId\": \"\",\n \"documentDate\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"trackingCode\": \"\",\n \"adjustmentReasonId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"unitCost\": \"\",\n \"notes\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"unitCost\": \"\",\n \"notes\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c4e3b706-90ba-49ad-a679-b786ec11d4ac", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-entries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"warehouseId\": \"\",\n \"documentDate\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"trackingCode\": \"\",\n \"adjustmentReasonId\": \"\",\n \"lines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"unitCost\": \"\",\n \"notes\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\",\n \"unitCost\": \"\",\n \"notes\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{id}", "description": "", "item": [ { "id": "c935b66d-42fd-4145-9a75-5ade7dd300e1", "name": "Get inventory entry by ID", "request": { "name": "Get inventory entry by ID", "description": { "content": "Returns a single inventory entry including its `lines`. The response carries a strong `ETag` header with the current version.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "inventory-entries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Inventory entry ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "e6c49670-d41b-4a87-9f0c-0a934d69b531", "name": "Inventory entry found", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-entries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inventory entry ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"version\": \"\",\n \"code\": \"\",\n \"series\": \"\",\n \"number\": \"\",\n \"warehouseId\": \"\",\n \"warehouseName\": \"\",\n \"companyId\": \"\",\n \"companyName\": \"\",\n \"documentDate\": \"\",\n \"internalRef\": \"\",\n \"externalRef\": \"\",\n \"notes\": \"\",\n \"trackingCode\": \"\",\n \"adjustmentReasonId\": \"\",\n \"adjustmentReasonName\": \"\",\n \"totalQuantity\": \"\",\n \"totalCost\": \"\",\n \"lines\": [\n {\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productId\": \"\",\n \"productName\": \"\",\n \"productSku\": \"\",\n \"quantity\": \"\",\n \"unitCost\": \"\",\n \"totalCost\": \"\",\n \"notes\": \"\"\n },\n {\n \"id\": \"\",\n \"lineNumber\": \"\",\n \"productId\": \"\",\n \"productName\": \"\",\n \"productSku\": \"\",\n \"quantity\": \"\",\n \"unitCost\": \"\",\n \"totalCost\": \"\",\n \"notes\": \"\"\n }\n ],\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8c41fed7-a674-43f7-9ea0-7ca8caefa411", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-entries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inventory entry ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bb061016-538b-470f-a29a-88f3d79c368e", "name": "Authenticated user is missing the `VER_TRASPASOS` permission", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-entries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inventory entry ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d23ce075-2b7f-40d7-b8b8-5d4d1a270ba7", "name": "Inventory entry not found", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-entries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inventory entry ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "22d3c5fb-73b8-4304-bcca-b19c40e0769f", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "inventory-entries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inventory entry ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "stock", "description": "", "item": [ { "id": "53f4910c-0a19-42a9-843e-aca1dda55632", "name": "List stock snapshots", "request": { "name": "List stock snapshots", "description": { "content": "Returns a paginated list of stock rows with envelope `{data, totalCount, skip, limit, hasMore}`. Scoped to the user's warehouses ({@code sucursalIds} claim). Supports optional RSQL `filter`, `sort` (default `barcode:asc`), `skip`/`limit` pagination and `modifiedAfter`/`modifiedBefore` bookends.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "stock" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "barcode:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "5e631a00-17f2-4add-b2e6-6da745e86527", "name": "Page of stock rows", "originalRequest": { "url": { "path": [ "api", "v2", "stock" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "barcode:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"totalCount\": \"\",\n \"skip\": \"\",\n \"limit\": \"\",\n \"hasMore\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6e29044d-e0f2-4a2c-85f5-13a038261257", "name": "Invalid filter or sort expression", "originalRequest": { "url": { "path": [ "api", "v2", "stock" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "barcode:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e459e772-0261-4d8a-be7a-b9ff4b24cfcf", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "stock" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "barcode:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "186224ea-6642-4f26-88e8-61ce24e9eb44", "name": "Authenticated user is missing the `VER_STOCK` permission", "originalRequest": { "url": { "path": [ "api", "v2", "stock" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "barcode:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a7e2ef7d-2868-42fd-a751-97d50590cb30", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "stock" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "RSQL filter expression. Allows filtering by any field exposed in the entity's field catalog.\n\n**Comparison operators**\n- `==` equals ÔÇö `series==F`\n- `!=` not equals ÔÇö `series!=F`\n- `=gt=` greater than ÔÇö `total=gt=1000`\n- `=ge=` greater or equal ÔÇö `total=ge=1000`\n- `=lt=` less than ÔÇö `total=lt=1000`\n- `=le=` less or equal ÔÇö `total=le=1000`\n- `=like=` contains, with `*` as wildcard ÔÇö `name=like=*Garcia*`\n- `=in=` value in list ÔÇö `series=in=(A,B,C)`\n- `=out=` value not in list ÔÇö `status=out=(VOID,DRAFT)`\n- `=null=` is null ÔÇö `paidAt=null=true`\n- `=notnull=` is not null ÔÇö `paidAt=notnull=true`\n- `=between=` between two values ÔÇö `documentDate=between=(2026-01-01,2026-12-31)`\n\n**Logical composition**\n- `;` AND ÔÇö `series==F;total=gt=1000`\n- `,` OR ÔÇö `status==OPEN,status==SENT`\n- `()` grouping ÔÇö `(status==OPEN,status==SENT);total=gt=1000`\n\n**Discoverability**\nThe list of filterable fields, allowed operators per type and UI hints is exposed at `GET /api/v2/schema/{Entity}` (use the internal Spanish entity name, for example `Factura`, `Pedido`, `Tercero`).", "type": "text/plain" }, "key": "filter", "value": "" }, { "disabled": false, "description": { "content": "Sort specification. Format `field:dir` (canonical) or `field,dir` (legacy). Multiple sort keys are separated by `;`. `dir` is `asc` (default) or `desc`. Examples: `lastModifiedAt:desc`, `documentDate:desc;number:asc`.", "type": "text/plain" }, "key": "sort", "value": "barcode:asc" }, { "disabled": false, "description": { "content": "Number of records to skip from the start of the result set (offset). Clamped to >= 0.", "type": "text/plain" }, "key": "skip", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of records to return per page. Hard cap of 200; values above are silently clamped down.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is greater than or equal to this ISO 8601 timestamp (e.g. `2026-01-01T00:00:00Z`). ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedAfter", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to records whose `lastModifiedAt` is less than or equal to this ISO 8601 timestamp. ANDed with the `filter` expression if both are sent.", "type": "text/plain" }, "key": "modifiedBefore", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{id}", "description": "", "item": [ { "id": "1fc4e113-9818-4221-b35e-4e4b71ecd4ba", "name": "Get stock row by composite ID", "request": { "name": "Get stock row by composite ID", "description": { "content": "Returns a single stock snapshot. The path parameter uses the legacy composite key `variantId_warehouseId` (e.g. `12045_3`).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "stock", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Composite stock id (variantId_warehouseId)", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "010532e9-871b-4085-8925-f94dccdc2173", "name": "Stock row found", "originalRequest": { "url": { "path": [ "api", "v2", "stock", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Composite stock id (variantId_warehouseId)", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"variantId\": \"\",\n \"warehouseId\": \"\",\n \"companyId\": \"\",\n \"warehouseName\": \"\",\n \"barcode\": \"\",\n \"description\": \"\",\n \"reference\": \"\",\n \"productName\": \"\",\n \"categoryName\": \"\",\n \"brandName\": \"\",\n \"groupName\": \"\",\n \"campaignName\": \"\",\n \"packQuantity\": \"\",\n \"variantEnabled\": \"\",\n \"inventoriable\": \"\",\n \"lastPurchasePrice\": \"\",\n \"purchasePriceSystem\": \"\",\n \"netSalePrice\": \"\",\n \"netSalePriceSystem\": \"\",\n \"grossSalePrice\": \"\",\n \"grossSalePriceSystem\": \"\",\n \"lastPurchaseDate\": \"\",\n \"quantity\": \"\",\n \"reservedQuantity\": \"\",\n \"minimumStock\": \"\",\n \"inboundCount\": \"\",\n \"outboundCount\": \"\",\n \"averageCost\": \"\",\n \"averageCostSystem\": \"\",\n \"stockValueAtAverageCost\": \"\",\n \"stockValueAtAverageCostSystem\": \"\",\n \"lastInboundAt\": \"\",\n \"lastOutboundAt\": \"\",\n \"lastModifiedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "66cefb7b-7064-4303-ae62-c7882e15692f", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "stock", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Composite stock id (variantId_warehouseId)", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1507114e-2417-4cfd-8441-94fadae57bb2", "name": "Authenticated user is missing the `VER_STOCK` permission", "originalRequest": { "url": { "path": [ "api", "v2", "stock", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Composite stock id (variantId_warehouseId)", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2d0b7206-9643-43df-bf08-a189a6af46d2", "name": "Stock row not found", "originalRequest": { "url": { "path": [ "api", "v2", "stock", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Composite stock id (variantId_warehouseId)", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d0320a11-175c-4941-8818-4714ad04edef", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "stock", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Composite stock id (variantId_warehouseId)", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "schema", "description": "", "item": [ { "id": "c75a1bd7-7382-43de-bb14-aed9a4288e7b", "name": "List registered entities", "request": { "name": "List registered entities", "description": { "content": "Returns the entity names that have a registered FieldDef catalog. Use one of these as the path variable on GET /{entity}.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "schema" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "8a6c0bde-a336-4667-880b-a39bb21e1366", "name": "Alphabetically sorted list of entity names", "originalRequest": { "url": { "path": [ "api", "v2", "schema" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "[\n \"\",\n \"\"\n]", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ed803312-2610-434e-8619-764ddb3f3bd8", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "schema" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bfd131d8-2803-4176-8c8d-8845828fb019", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "schema" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{entity}", "description": "", "item": [ { "id": "2a114b58-dd14-4276-881c-107bf748f04a", "name": "Get field descriptors for an entity", "request": { "name": "Get field descriptors for an entity", "description": { "content": "Returns the list of non-INTERNAL field descriptors for the given entity (use the internal Spanish entity name, e.g. \"Factura\", \"Pedido\", \"Tercero\").", "type": "text/plain" }, "url": { "path": [ "api", "v2", "schema", ":entity" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "entity", "disabled": false, "description": { "content": "(Required) Internal entity name (Spanish)", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "3d2ddd3c-4565-4d6a-a184-5d5cbc382d27", "name": "Field descriptors for the entity", "originalRequest": { "url": { "path": [ "api", "v2", "schema", ":entity" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Internal entity name (Spanish)", "type": "text/plain" }, "type": "any", "value": "", "key": "entity" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "[\n {\n \"apiName\": \"\",\n \"javaType\": \"\",\n \"category\": \"\",\n \"label\": \"\",\n \"group\": \"\",\n \"displayOrder\": \"\",\n \"required\": \"\",\n \"editable\": \"\",\n \"capabilities\": [\n \"\",\n \"\"\n ],\n \"allowedFilterOperators\": [\n \"\",\n \"\"\n ],\n \"defaultFilterOperator\": \"\",\n \"allowedAggregations\": [\n \"\",\n \"\"\n ],\n \"uiComponent\": \"\",\n \"alignment\": \"\",\n \"columnWidth\": \"\",\n \"displayFormat\": \"\",\n \"minLength\": \"\",\n \"maxLength\": \"\",\n \"validationPattern\": \"\",\n \"customFieldId\": \"\",\n \"customFieldScope\": \"\",\n \"valueType\": \"\",\n \"contentType\": \"\",\n \"options\": [\n {\n \"id\": \"\",\n \"value\": \"\",\n \"label\": \"\",\n \"hex\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"value\": \"\",\n \"label\": \"\",\n \"hex\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"optionCount\": \"\"\n },\n {\n \"apiName\": \"\",\n \"javaType\": \"\",\n \"category\": \"\",\n \"label\": \"\",\n \"group\": \"\",\n \"displayOrder\": \"\",\n \"required\": \"\",\n \"editable\": \"\",\n \"capabilities\": [\n \"\",\n \"\"\n ],\n \"allowedFilterOperators\": [\n \"\",\n \"\"\n ],\n \"defaultFilterOperator\": \"\",\n \"allowedAggregations\": [\n \"\",\n \"\"\n ],\n \"uiComponent\": \"\",\n \"alignment\": \"\",\n \"columnWidth\": \"\",\n \"displayFormat\": \"\",\n \"minLength\": \"\",\n \"maxLength\": \"\",\n \"validationPattern\": \"\",\n \"customFieldId\": \"\",\n \"customFieldScope\": \"\",\n \"valueType\": \"\",\n \"contentType\": \"\",\n \"options\": [\n {\n \"id\": \"\",\n \"value\": \"\",\n \"label\": \"\",\n \"hex\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"value\": \"\",\n \"label\": \"\",\n \"hex\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"optionCount\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "310ed53c-ca51-4217-af52-e8fa672ecc0f", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "schema", ":entity" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Internal entity name (Spanish)", "type": "text/plain" }, "type": "any", "value": "", "key": "entity" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "85203143-8b6b-4619-b7e2-fc34fdb18d51", "name": "Entity not registered in the FieldDefRegistry", "originalRequest": { "url": { "path": [ "api", "v2", "schema", ":entity" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Internal entity name (Spanish)", "type": "text/plain" }, "type": "any", "value": "", "key": "entity" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ae05bd97-3344-4d8d-9964-1477c00c0060", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "schema", ":entity" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Internal entity name (Spanish)", "type": "text/plain" }, "type": "any", "value": "", "key": "entity" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "catalogs", "description": "", "item": [ { "id": "92f514e8-f08a-407b-8399-2b543d5b3880", "name": "List catalog definitions", "request": { "name": "List catalog definitions", "description": { "content": "Machine-readable inventory of registered catalog keys and the contextual parameters accepted by each one. Use this contract instead of hardcoding dynamic-catalog requirements in the SPA.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "catalogs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "0b38cf05-075a-4f47-9061-3200cb134661", "name": "Catalog definitions", "originalRequest": { "url": { "path": [ "api", "v2", "catalogs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "[\n {\n \"companyRequired\": \"\",\n \"key\": \"\",\n \"parameters\": [\n {\n \"name\": \"\",\n \"required\": \"\",\n \"type\": \"BOOLEAN\"\n },\n {\n \"name\": \"\",\n \"required\": \"\",\n \"type\": \"BOOLEAN\"\n }\n ],\n \"source\": \"DYNAMIC\"\n },\n {\n \"companyRequired\": \"\",\n \"key\": \"\",\n \"parameters\": [\n {\n \"name\": \"\",\n \"required\": \"\",\n \"type\": \"BOOLEAN\"\n },\n {\n \"name\": \"\",\n \"required\": \"\",\n \"type\": \"STRING\"\n }\n ],\n \"source\": \"DYNAMIC\"\n }\n]", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "529f15a0-f35c-4172-bea6-d629ee8fd617", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "catalogs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d1f249b5-9a9b-429f-828f-b0460240c661", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "catalogs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{catalog}", "description": "", "item": [ { "id": "a42cf87a-e252-470b-b226-b9f9dd894ca6", "name": "List a dynamic catalog", "request": { "name": "List a dynamic catalog", "description": { "content": "Returns the `[{code, name}, ...]` array used by AG Grid Set Filters and form selects/autocompletes. Returned values are already translated according to `Accept-Language` (when applicable). Supply the optional `q` to filter for autocomplete and `limit` (default 50, cap 500) to control payload size. For company-scoped catalogs such as `accountingAccount`, supply `companyId` to restrict entries to that company (must be within the JWT company scope). Contextual catalogs additionally accept filter parameters mirroring the legacy autocompletes (e.g. `forSales`, `priceListType`, `documentKind`); a missing mandatory filter is rejected with `400`. Cached privately for 1 minute only when no `q`, `companyId` nor contextual filter is supplied; not cached otherwise.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "catalogs", ":catalog" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Optional autocomplete text. Case-insensitive `contains` match on name and code. Trimmed; ignored when blank.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Maximum entries to return. Default 50, hard cap 500.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Optional company scope for company-scoped catalogs (e.g. accountingAccount). Must belong to the JWT company set.", "type": "text/plain" }, "key": "companyId", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "catalog", "disabled": false, "description": { "content": "(Required) Catalog key (matches `FilterParams.catalog` on a `ColumnDefinition` or the entity stem in singular for FK lookups, e.g. `gender`, `brand`, `customer`).", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "94da9754-4d40-4663-a701-91adf3ea8cbe", "name": "Catalog entries", "originalRequest": { "url": { "path": [ "api", "v2", "catalogs", ":catalog" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Optional autocomplete text. Case-insensitive `contains` match on name and code. Trimmed; ignored when blank.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Maximum entries to return. Default 50, hard cap 500.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Optional company scope for company-scoped catalogs (e.g. accountingAccount). Must belong to the JWT company set.", "type": "text/plain" }, "key": "companyId", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Catalog key (matches `FilterParams.catalog` on a `ColumnDefinition` or the entity stem in singular for FK lookups, e.g. `gender`, `brand`, `customer`).", "type": "text/plain" }, "type": "any", "value": "", "key": "catalog" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"id\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"applicableWhen\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n },\n \"attributes\": {\n \"key_0\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f364841e-934f-4f68-9e54-1c969278df7b", "name": "A mandatory contextual filter is missing", "originalRequest": { "url": { "path": [ "api", "v2", "catalogs", ":catalog" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Optional autocomplete text. Case-insensitive `contains` match on name and code. Trimmed; ignored when blank.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Maximum entries to return. Default 50, hard cap 500.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Optional company scope for company-scoped catalogs (e.g. accountingAccount). Must belong to the JWT company set.", "type": "text/plain" }, "key": "companyId", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Catalog key (matches `FilterParams.catalog` on a `ColumnDefinition` or the entity stem in singular for FK lookups, e.g. `gender`, `brand`, `customer`).", "type": "text/plain" }, "type": "any", "value": "", "key": "catalog" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "87a4fe8e-8709-4cdd-a715-72be0c8f114d", "name": "Missing or invalid JWT (Bearer token).", "originalRequest": { "url": { "path": [ "api", "v2", "catalogs", ":catalog" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Optional autocomplete text. Case-insensitive `contains` match on name and code. Trimmed; ignored when blank.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Maximum entries to return. Default 50, hard cap 500.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Optional company scope for company-scoped catalogs (e.g. accountingAccount). Must belong to the JWT company set.", "type": "text/plain" }, "key": "companyId", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Catalog key (matches `FilterParams.catalog` on a `ColumnDefinition` or the entity stem in singular for FK lookups, e.g. `gender`, `brand`, `customer`).", "type": "text/plain" }, "type": "any", "value": "", "key": "catalog" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f7ed6a8a-03c4-4b3c-86bd-b7d21ea945c8", "name": "Unknown catalog key", "originalRequest": { "url": { "path": [ "api", "v2", "catalogs", ":catalog" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Optional autocomplete text. Case-insensitive `contains` match on name and code. Trimmed; ignored when blank.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Maximum entries to return. Default 50, hard cap 500.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Optional company scope for company-scoped catalogs (e.g. accountingAccount). Must belong to the JWT company set.", "type": "text/plain" }, "key": "companyId", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Catalog key (matches `FilterParams.catalog` on a `ColumnDefinition` or the entity stem in singular for FK lookups, e.g. `gender`, `brand`, `customer`).", "type": "text/plain" }, "type": "any", "value": "", "key": "catalog" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8a0b21e9-9bb2-4a15-96b0-5e3c4367535a", "name": "Unexpected server error. Includes legacy WAR failures that are not classified as `502` / `503` / `504`.", "originalRequest": { "url": { "path": [ "api", "v2", "catalogs", ":catalog" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Optional autocomplete text. Case-insensitive `contains` match on name and code. Trimmed; ignored when blank.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Maximum entries to return. Default 50, hard cap 500.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Optional company scope for company-scoped catalogs (e.g. accountingAccount). Must belong to the JWT company set.", "type": "text/plain" }, "key": "companyId", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Catalog key (matches `FilterParams.catalog` on a `ColumnDefinition` or the entity stem in singular for FK lookups, e.g. `gender`, `brand`, `customer`).", "type": "text/plain" }, "type": "any", "value": "", "key": "catalog" } ] }, "header": [ { "key": "Accept", "value": "*/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"properties\": {\n \"key_0\": 1940.6534650547558\n }\n}", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "event": [], "variable": [ { "key": "baseUrl", "value": "/" }, { "key": "username", "value": "", "type": "string" }, { "key": "password", "value": "", "type": "string" }, { "key": "token", "value": "", "type": "string" } ], "info": { "_postman_id": "b3341324-cab2-46e7-99b1-43457bf0d1e4", "name": "GESMO API v2", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "Public REST API for the GESMO / Gesvision ERP. Dates: ISO 8601 with the business time zone offset (ADR-007). Amounts: JSON numbers with 2 decimals HALF_UP (ADR-008). Pagination: skip/limit with a hard cap of 200 per page.\n\nContact Support:\n Name: GESMO Team", "type": "text/plain" } } }