{ "info": { "_postman_id": "a860f863-fea8-44ad-886d-efc0ab5ee72b", "name": "fiskaly SIGN IT (Version 2026-06-01) Postman Collection", "description": "This Postman collection covers the basic workflow of SIGN IT (Version 2026-06-01). Further information is provided in our Integration Guide and API documentation.\n\nWhen this collection is executed with Postman, important parts of the results will be stored in the current selected Postman environment.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "41815824" }, "item": [ { "name": "tokens (management)", "item": [ { "name": "Create a Token", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", " var data = pm.response.json();", " pm.environment.set(\"apiBearerToken\", data.content.authentication.bearer);", "});" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Api-Version", "value": "{{apiVersion}}", "description": "API version" }, { "key": "X-Idempotency-Key", "value": "{{$guid}}", "description": "(Required) Idempotency key" } ], "body": { "mode": "raw", "raw": "{\n \"content\": {\n \"type\": \"API_KEY\",\n \"key\": \"{{apiKey}}\",\n \"secret\": \"{{apiSecret}}\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{apiBaseUrl}}/tokens", "host": [ "{{apiBaseUrl}}" ], "path": [ "tokens" ] }, "description": "Create a token for API authentication" }, "response": [] } ], "description": "Use the API Key and API Secret generated for your Organization `GROUP` via HUB to authenticate and obtain an access token." }, { "name": "organizations", "item": [ { "name": "Create an Organization", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", " var data = pm.response.json();", " pm.environment.set(\"organizationId\", data.content.id);", "});" ], "type": "text/javascript", "packages": {}, "requests": {} } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiBearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Api-Version", "value": "{{apiVersion}}", "description": "API version" }, { "key": "X-Idempotency-Key", "value": "{{$guid}}", "description": "(Required) Idempotency key" } ], "body": { "mode": "raw", "raw": "{\n \"content\": {\n \"type\": \"UNIT\",\n \"name\": \"{{$randomCompanyName}}\"\n },\n \"metadata\": {\n \"key\": \"value\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{apiBaseUrl}}/organizations", "host": [ "{{apiBaseUrl}}" ], "path": [ "organizations" ] }, "description": "Create an Organization `UNIT`" }, "response": [] }, { "name": "Retrieve an Organization", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});" ], "type": "text/javascript", "packages": {} } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiBearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Api-Version", "value": "{{apiVersion}}", "description": "API version" } ], "url": { "raw": "{{apiBaseUrl}}/organizations/{{organizationId}}", "host": [ "{{apiBaseUrl}}" ], "path": [ "organizations", "{{organizationId}}" ] }, "description": "Retrieve an Organization `UNIT` by ID" }, "response": [] }, { "name": "Update an Organization", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});" ], "type": "text/javascript", "packages": {} } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiBearerToken}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Api-Version", "value": "{{apiVersion}}", "description": "API version" }, { "key": "X-Idempotency-Key", "value": "{{$guid}}", "description": "(Required) Idempotency key" } ], "body": { "mode": "raw", "raw": "{\n \"content\": {\n \"name\": \"Updated Organization Name\"\n },\n \"metadata\": {\n \"updated_key\": \"updated_value\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{apiBaseUrl}}/organizations/{{organizationId}}", "host": [ "{{apiBaseUrl}}" ], "path": [ "organizations", "{{organizationId}}" ] }, "description": "Update an Organization `UNIT`" }, "response": [] }, { "name": "List Organizations", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});" ], "type": "text/javascript", "packages": {} } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiBearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Api-Version", "value": "{{apiVersion}}", "description": "API version" } ], "url": { "raw": "{{apiBaseUrl}}/organizations", "host": [ "{{apiBaseUrl}}" ], "path": [ "organizations" ] }, "description": "Retrieve a list of Organizations `UNIT`" }, "response": [] } ], "description": "Create an Organization `UNIT` for each of your taxpayer representations. \nYou only need to assign a `name` at this stage. All fiscal information must be added later via the `Taxpayer` resource." }, { "name": "subjects", "item": [ { "name": "Create a Subject::API_KEY", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", " var data = pm.response.json();", " pm.environment.set(\"subjectId\", data.content.id);", " pm.environment.set(\"subjectApiKey\", data.content.credentials.key);", " pm.environment.set(\"subjectApiSecret\", data.content.credentials.secret);", "});" ], "type": "text/javascript", "packages": {}, "requests": {} } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiBearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Api-Version", "value": "{{apiVersion}}", "description": "API version" }, { "key": "X-Idempotency-Key", "value": "{{$guid}}", "description": "(Required) Idempotency key" }, { "key": "X-Scope-Identifier", "value": "{{organizationId}}", "description": "Scope identifier for the subject" } ], "body": { "mode": "raw", "raw": "{\n \"content\": {\n \"type\": \"API_KEY\",\n \"name\": \"my-api-key-03\"\n },\n \"metadata\": {\n \"key\": \"value\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{apiBaseUrl}}/subjects", "host": [ "{{apiBaseUrl}}" ], "path": [ "subjects" ] }, "description": "Create a Subject of type `API_KEY`" }, "response": [] }, { "name": "Retrieve a Subject::API_KEY", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});" ], "type": "text/javascript", "packages": {} } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiBearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Api-Version", "value": "{{apiVersion}}", "description": "API version" } ], "url": { "raw": "{{apiBaseUrl}}/subjects/{{subjectId}}", "host": [ "{{apiBaseUrl}}" ], "path": [ "subjects", "{{subjectId}}" ] }, "description": "Retrieve a Subject of type `API_KEY` by ID" }, "response": [] }, { "name": "List Subjects", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiBearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Api-Version", "value": "{{apiVersion}}", "description": "API version" } ], "url": { "raw": "{{apiBaseUrl}}/subjects", "host": [ "{{apiBaseUrl}}" ], "path": [ "subjects" ] }, "description": "List Subjects of type `API_KEY`" }, "response": [] }, { "name": "Update a Subject::API_KEY", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiBearerToken}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Api-Version", "value": "{{apiVersion}}", "description": "API version" }, { "key": "X-Idempotency-Key", "value": "{{$guid}}", "description": "(Required) Idempotency key" } ], "body": { "mode": "raw", "raw": "{\n \"content\": {\n \"type\": \"API_KEY\",\n \"name\": \"my-api-key-updated\"\n },\n \"metadata\": {\n \"key\": \"value\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{apiBaseUrl}}/subjects/{{subjectId}}", "host": [ "{{apiBaseUrl}}" ], "path": [ "subjects", "{{subjectId}}" ] }, "description": "Update a Subject of type `API_KEY`" }, "response": [] } ], "description": "Create a Subject of type `API_KEY` for each Organization `UNIT`.\n\nTo link the API key to the correct Organization `UNIT`, set the `X-Scope-Identifier` header to that Organization `UNIT`'s ID.\n\nThe response will provide the `key` and `secret` required for the next step." }, { "name": "tokens (operation)", "item": [ { "name": "Create a Token", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", " var data = pm.response.json();", " pm.environment.set(\"subjectBearerToken\", data.content.authentication.bearer);", "});" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Api-Version", "value": "{{apiVersion}}", "description": "API version" }, { "key": "X-Idempotency-Key", "value": "{{$guid}}", "description": "(Required) Idempotency key" } ], "body": { "mode": "raw", "raw": "{\n \"content\": {\n \"type\": \"API_KEY\",\n \"key\": \"{{subjectApiKey}}\",\n \"secret\": \"{{subjectApiSecret}}\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{apiBaseUrl}}/tokens", "host": [ "{{apiBaseUrl}}" ], "path": [ "tokens" ] }, "description": "Create a token using the `key` and `secret` returned when creating the Subject (`API_KEY`)" }, "response": [] } ], "description": "Use the generated `key` and `secret` returned when creating the Subject (`API_KEY`) to obtain an access token for the corresponding Organization `UNIT`.\n\nThis token is required for all subsequent calls." }, { "name": "taxpayers", "item": [ { "name": "Create a Taxpayer::COMPANY", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", " var data = pm.response.json();", " pm.environment.set(\"taxpayerId\", data.content.id);", "});" ], "type": "text/javascript", "packages": {}, "requests": {} } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{subjectBearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Api-Version", "value": "{{apiVersion}}", "description": "API version" }, { "key": "X-Idempotency-Key", "value": "{{$guid}}", "description": "(Required) Idempotency key" } ], "body": { "mode": "raw", "raw": "{\n \"content\": {\n \"type\": \"COMPANY\",\n \"name\": {\n \"legal\": \"My Business Legal Name\",\n \"trade\": \"My Brand\"\n },\n \"address\": {\n \"line\": {\n \"type\": \"STREET_NUMBER\",\n \"street\": \"Via Roma\",\n \"number\": \"123\",\n \"prefix\": \"0000\",\n \"infix\": \"1234\",\n \"suffix\": \"6789\"\n },\n \"code\": \"00100\",\n \"city\": \"Rome\",\n \"country\": \"IT\"\n },\n \"fiscalization\": {\n \"type\": \"IT\",\n \"tax_id_number\": \"12345678901\",\n \"vat_id_number\": \"12345678901\",\n \"credentials\": {\n \"type\": \"FISCONLINE\",\n \"pin\": \"1234567890\",\n \"password\": \"MySecurePassword123\",\n \"tax_id_number\": \"RSSMRA85M01H501Z\"\n }\n }\n },\n \"metadata\": {\n \"key\": \"value\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{apiBaseUrl}}/taxpayers", "host": [ "{{apiBaseUrl}}" ], "path": [ "taxpayers" ] }, "description": "Create a Taxpayer. This example shows a Taxpayer of type `COMPANY` .\n\nFor creating a Taxpayer of type `INDIVIDUAL`, refer to our API documentation." }, "response": [] }, { "name": "Retrieve a Taxpayer::COMPANY", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});" ], "type": "text/javascript", "packages": {} } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{subjectBearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Api-Version", "value": "{{apiVersion}}", "description": "API version" } ], "url": { "raw": "{{apiBaseUrl}}/taxpayers/{{taxpayerId}}", "host": [ "{{apiBaseUrl}}" ], "path": [ "taxpayers", "{{taxpayerId}}" ] }, "description": "Retrieve a Taxpayer by ID" }, "response": [] }, { "name": "Update a Taxpayer::COMPANY (Commission)", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", " var data = pm.response.json();", " pm.test(\"State is COMMISSIONED\", function () {", " pm.expect(data.content.state).to.eql(\"COMMISSIONED\");", " });", "});" ], "type": "text/javascript", "packages": {}, "requests": {} } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{subjectBearerToken}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Api-Version", "value": "{{apiVersion}}", "description": "API version" }, { "key": "X-Idempotency-Key", "value": "{{$guid}}", "description": "(Required) Idempotency key" } ], "body": { "mode": "raw", "raw": "{\n \"content\": {\n \"state\": \"COMMISSIONED\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{apiBaseUrl}}/taxpayers/{{taxpayerId}}", "host": [ "{{apiBaseUrl}}" ], "path": [ "taxpayers", "{{taxpayerId}}" ] }, "description": "Update a Taxpayer to `COMMISSIONED` state" }, "response": [] }, { "name": "List Taxpayers", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});" ], "type": "text/javascript", "packages": {} } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{subjectBearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Api-Version", "value": "{{apiVersion}}", "description": "API version" } ], "url": { "raw": "{{apiBaseUrl}}/taxpayers", "host": [ "{{apiBaseUrl}}" ], "path": [ "taxpayers" ] }, "description": "Retrieve a list of Taxpayers" }, "response": [] }, { "name": "List Taxpayers with pagination (first page)", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", " var data = pm.response.json();", " if (data.pagination && data.pagination.token) {", " pm.environment.set(\"taxpayerPaginationToken\", data.pagination.token);", " }", "});" ], "type": "text/javascript", "packages": {} } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{subjectBearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Api-Version", "value": "{{apiVersion}}", "description": "API version" } ], "url": { "raw": "{{apiBaseUrl}}/taxpayers?limit=10", "host": [ "{{apiBaseUrl}}" ], "path": [ "taxpayers" ], "query": [ { "key": "limit", "value": "10" } ] }, "description": "Retrieve first page of Taxpayers with limit" }, "response": [] } ], "description": "Create a Taxpayer to assign taxpayer information and country-specific fiscalization data to a specific Organization `UNIT`." }, { "name": "locations", "item": [ { "name": "Create a Location::BRANCH", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", " var data = pm.response.json();", " pm.environment.set(\"locationId\", data.content.id);", "});" ], "type": "text/javascript", "packages": {}, "requests": {} } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{subjectBearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Api-Version", "value": "{{apiVersion}}", "description": "API version" }, { "key": "X-Idempotency-Key", "value": "{{$guid}}", "description": "(Required) Idempotency key" } ], "body": { "mode": "raw", "raw": "{\n \"content\": {\n \"type\": \"BRANCH\",\n \"taxpayer\": {\n \"id\": \"{{taxpayerId}}\"\n },\n \"name\": \"My Store Branch\",\n \"address\": {\n \"line\": {\n \"type\": \"STREET_NUMBER\",\n \"street\": \"Viale Farini\",\n \"number\": \"512\",\n \"prefix\": \"0000\",\n \"infix\": \"1234\",\n \"suffix\": \"6789\"\n },\n \"code\": \"48125\",\n \"city\": \"Ravenna\",\n \"country\": \"IT\"\n }\n },\n \"metadata\": {\n \"store_code\": \"STORE001\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{apiBaseUrl}}/locations", "host": [ "{{apiBaseUrl}}" ], "path": [ "locations" ] }, "description": "Create a Location of type `BRANCH`" }, "response": [] }, { "name": "Retrieve a Location::BRANCH", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});" ], "type": "text/javascript", "packages": {} } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{subjectBearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Api-Version", "value": "{{apiVersion}}", "description": "API version" } ], "url": { "raw": "{{apiBaseUrl}}/locations/{{locationId}}", "host": [ "{{apiBaseUrl}}" ], "path": [ "locations", "{{locationId}}" ] }, "description": "Retrieve a Location by ID" }, "response": [] }, { "name": "Update a Location::BRANCH (Commission)", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", " var data = pm.response.json();", " pm.test(\"State is COMMISSIONED\", function () {", " pm.expect(data.content.state).to.eql(\"COMMISSIONED\");", " });", "});" ], "type": "text/javascript", "packages": {}, "requests": {} } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{subjectBearerToken}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Api-Version", "value": "{{apiVersion}}", "description": "API version" }, { "key": "X-Idempotency-Key", "value": "{{$guid}}", "description": "(Required) Idempotency key" } ], "body": { "mode": "raw", "raw": "{\n \"content\": {\n \"state\": \"COMMISSIONED\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{apiBaseUrl}}/locations/{{locationId}}", "host": [ "{{apiBaseUrl}}" ], "path": [ "locations", "{{locationId}}" ] }, "description": "Update a Location of type `BRANCH` to `COMMISSIONED` state" }, "response": [] }, { "name": "List Locations", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});" ], "type": "text/javascript", "packages": {} } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{subjectBearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Api-Version", "value": "{{apiVersion}}", "description": "API version" } ], "url": { "raw": "{{apiBaseUrl}}/locations", "host": [ "{{apiBaseUrl}}" ], "path": [ "locations" ] }, "description": "Retrieve a list of Locations" }, "response": [] }, { "name": "List Locations by Taxpayer", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});" ], "type": "text/javascript", "packages": {} } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{subjectBearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Api-Version", "value": "{{apiVersion}}", "description": "API version" } ], "url": { "raw": "{{apiBaseUrl}}/locations?taxpayer_id={{taxpayerId}}", "host": [ "{{apiBaseUrl}}" ], "path": [ "locations" ], "query": [ { "key": "taxpayer_id", "value": "{{taxpayerId}}" } ] }, "description": "Retrieve Locations filtered by Taxpayer ID" }, "response": [] } ], "description": "Create a Location of type `BRANCH` for each operating business location" }, { "name": "systems (FISCAL_DEVICE)", "item": [ { "name": "Create a System::FISCAL_DEVICE (INTERNAL)", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", " var data = pm.response.json();", " pm.environment.set(\"fiscalDeviceId\", data.content.id);", "});" ], "type": "text/javascript", "packages": {}, "requests": {} } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{subjectBearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Api-Version", "value": "{{apiVersion}}", "description": "API version" }, { "key": "X-Idempotency-Key", "value": "{{$guid}}", "description": "(Required) Idempotency key" } ], "body": { "mode": "raw", "raw": "{\n \"content\": {\n \"type\": \"FISCAL_DEVICE\",\n \"location\": {\n \"id\": \"{{locationId}}\"\n },\n \"producer\": {\n \"type\": \"MPN\",\n \"number\": \"FD-001\",\n \"details\": {\n \"name\": \"TouchPoint Terminal\"\n }\n },\n \"software\": {\n \"name\": \"Opera PMS\",\n \"version\": \"v1.0.0\"\n }\n },\n \"metadata\": {\n \"device_label\": \"POS-1\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{apiBaseUrl}}/systems", "host": [ "{{apiBaseUrl}}" ], "path": [ "systems" ] }, "description": "Create a System of type `FISCAL_DEVICE`." }, "response": [] }, { "name": "Update a System::FISCAL_DEVICE (Commission)", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", " var data = pm.response.json();", " pm.test(\"State is COMMISSIONED\", function () {", " pm.expect(data.content.state).to.eql(\"COMMISSIONED\");", " });", "});" ], "type": "text/javascript", "packages": {}, "requests": {} } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{subjectBearerToken}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Api-Version", "value": "{{apiVersion}}", "description": "API version" }, { "key": "X-Idempotency-Key", "value": "{{$guid}}", "description": "(Required) Idempotency key" } ], "body": { "mode": "raw", "raw": "{\n \"content\": {\n \"state\": \"COMMISSIONED\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{apiBaseUrl}}/systems/{{fiscalDeviceId}}", "host": [ "{{apiBaseUrl}}" ], "path": [ "systems", "{{fiscalDeviceId}}" ] }, "description": "Update a System to `COMMISSIONED` state" }, "response": [] }, { "name": "Retrieve a System::FISCAL_DEVICE", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});" ], "type": "text/javascript", "packages": {} } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{subjectBearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Api-Version", "value": "{{apiVersion}}", "description": "API version" } ], "url": { "raw": "{{apiBaseUrl}}/systems/{{fiscalDeviceId}}", "host": [ "{{apiBaseUrl}}" ], "path": [ "systems", "{{fiscalDeviceId}}" ] }, "description": "Retrieve a System by ID" }, "response": [] }, { "name": "List Systems", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});" ], "type": "text/javascript", "packages": {} } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{subjectBearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Api-Version", "value": "{{apiVersion}}", "description": "API version" } ], "url": { "raw": "{{apiBaseUrl}}/systems", "host": [ "{{apiBaseUrl}}" ], "path": [ "systems" ] }, "description": "Retrieve a list of Systems" }, "response": [] } ], "description": "Create a System of type `FISCAL_DEVICE` for each abstraction of a cash register used for fiscal operations." }, { "name": "records (RECEIPT)", "item": [ { "name": "Create a Record::INTENTION", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", " var data = pm.response.json();", " pm.environment.set(\"intentionId\", data.content.id);", "});" ], "type": "text/javascript", "packages": {}, "requests": {} } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{subjectBearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Api-Version", "value": "{{apiVersion}}", "description": "API version" }, { "key": "X-Idempotency-Key", "value": "{{$guid}}", "description": "(Required) Idempotency key" } ], "body": { "mode": "raw", "raw": "{\n \"content\": {\n \"type\": \"INTENTION\",\n \"operation\": {\n \"type\": \"TRANSACTION\"\n },\n \"system\": {\n \"id\": \"{{fiscalDeviceId}}\"\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{apiBaseUrl}}/records", "host": [ "{{apiBaseUrl}}" ], "path": [ "records" ] }, "description": "Create a `Record::INTENTION` for a `TRANSACTION` operation" }, "response": [] }, { "name": "Retrieve a Record::INTENTION", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});" ], "type": "text/javascript", "packages": {} } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{subjectBearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Api-Version", "value": "{{apiVersion}}", "description": "API version" } ], "url": { "raw": "{{apiBaseUrl}}/records/{{intentionId}}", "host": [ "{{apiBaseUrl}}" ], "path": [ "records", "{{intentionId}}" ] }, "description": "Retrieve a Record by ID" }, "response": [] }, { "name": "Update a Record::INTENTION", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});" ], "type": "text/javascript", "packages": {} } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{subjectBearerToken}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Api-Version", "value": "{{apiVersion}}", "description": "API version" }, { "key": "X-Idempotency-Key", "value": "{{$guid}}", "description": "(Required) Idempotency key" } ], "body": { "mode": "raw", "raw": "{\n \"metadata\": {\n \"updated_key\": \"updated_value\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{apiBaseUrl}}/records/{{intentionId}}", "host": [ "{{apiBaseUrl}}" ], "path": [ "records", "{{intentionId}}" ] }, "description": "Update a `Record::INTENTION` metadata" }, "response": [] }, { "name": "Create a Record::TRANSACTION::RECEIPT", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", " var data = pm.response.json();", " pm.environment.set(\"receiptId\", data.content.id);", "});" ], "type": "text/javascript", "packages": {}, "requests": {} } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{subjectBearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Api-Version", "value": "{{apiVersion}}", "description": "API version" }, { "key": "X-Idempotency-Key", "value": "{{$guid}}", "description": "(Required) Idempotency key" } ], "body": { "mode": "raw", "raw": "{\n \"content\": {\n \"type\": \"TRANSACTION\",\n \"record\": {\n \"id\": \"{{intentionId}}\"\n },\n \"operation\": {\n \"type\": \"RECEIPT\",\n \"document\": {\n \"number\": \"0001\"\n },\n \"entries\": [\n {\n \"type\": \"SALE\",\n \"details\": {\n \"concept\": \"GOOD\"\n },\n \"data\": {\n \"type\": \"ITEM\",\n \"text\": \"Product A\",\n \"unit\": {\n \"quantity\": \"2.00\",\n \"price\": {\n \"inclusive\": \"12.20\",\n \"exclusive\": \"10.00\"\n }\n },\n \"value\": {\n \"base\": \"20.00\",\n \"discount\": \"0.00\"\n },\n \"vat\": {\n \"type\": \"VAT_RATE\",\n \"code\": \"STANDARD\",\n \"percentage\": \"22.00\",\n \"exclusive\": \"20.00\",\n \"inclusive\": \"24.40\",\n \"amount\": \"4.40\"\n }\n }\n },\n {\n \"type\": \"SALE\",\n \"details\": {\n \"concept\": \"SERVICE\"\n },\n \"data\": {\n \"type\": \"ITEM\",\n \"text\": \"Service B\",\n \"unit\": {\n \"quantity\": \"1.00\",\n \"price\": {\n \"inclusive\": \"0.60\",\n \"exclusive\": \"0.54545455\"\n }\n },\n \"value\": {\n \"base\": \"0.54545455\",\n \"discount\": \"0.00\"\n },\n \"vat\": {\n \"type\": \"VAT_RATE\",\n \"code\": \"REDUCED_1\",\n \"percentage\": \"10.00\",\n \"exclusive\": \"0.54545455\",\n \"inclusive\": \"0.60\",\n \"amount\": \"0.05454545\"\n }\n }\n }\n ],\n \"breakdown\": [\n {\n \"type\": \"VAT_RATE\",\n \"code\": \"STANDARD\",\n \"percentage\": \"22.00\",\n \"exclusive\": \"20.00\",\n \"inclusive\": \"24.40\",\n \"amount\": \"4.40\"\n },\n {\n \"type\": \"VAT_RATE\",\n \"code\": \"REDUCED_1\",\n \"percentage\": \"10.00\",\n \"exclusive\": \"0.54545455\",\n \"inclusive\": \"0.60\",\n \"amount\": \"0.05454545\"\n }\n ],\n \"totals\": {\n \"vat\": {\n \"amount\": \"4.45454545\",\n \"exclusive\": \"20.54545455\",\n \"inclusive\": \"25.00\"\n }\n },\n \"payments\": [\n {\n \"type\": \"CASH\",\n \"details\": {\n \"amount\": \"25.00\"\n }\n }\n ]\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{apiBaseUrl}}/records", "host": [ "{{apiBaseUrl}}" ], "path": [ "records" ] }, "description": "Create a `Record::TRANSACTION::RECEIPT`" }, "response": [] }, { "name": "Retrieve a Record::TRANSACTION::RECEIPT", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});" ], "type": "text/javascript", "packages": {} } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{subjectBearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Api-Version", "value": "{{apiVersion}}", "description": "API version" } ], "url": { "raw": "{{apiBaseUrl}}/records/{{receiptId}}", "host": [ "{{apiBaseUrl}}" ], "path": [ "records", "{{receiptId}}" ] }, "description": "Retrieve a `RECEIPT` Record by ID" }, "response": [] }, { "name": "Update a Record::TRANSACTION::RECEIPT", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});" ], "type": "text/javascript", "packages": {} } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{subjectBearerToken}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Api-Version", "value": "{{apiVersion}}", "description": "API version" }, { "key": "X-Idempotency-Key", "value": "{{$guid}}", "description": "(Required) Idempotency key" } ], "body": { "mode": "raw", "raw": "{\n \"metadata\": {\n \"receipt_note\": \"Customer requested copy\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{apiBaseUrl}}/records/{{receiptId}}", "host": [ "{{apiBaseUrl}}" ], "path": [ "records", "{{receiptId}}" ] }, "description": "Update a `RECEIPT` Record metadata" }, "response": [] }, { "name": "List Records", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});" ], "type": "text/javascript", "packages": {} } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{subjectBearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Api-Version", "value": "{{apiVersion}}", "description": "API version" } ], "url": { "raw": "{{apiBaseUrl}}/records", "host": [ "{{apiBaseUrl}}" ], "path": [ "records" ] }, "description": "Retrieve a list of Records" }, "response": [] }, { "name": "List Records by Type", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});" ], "type": "text/javascript", "packages": {} } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{subjectBearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Api-Version", "value": "{{apiVersion}}", "description": "API version" } ], "url": { "raw": "{{apiBaseUrl}}/records?type=TRANSACTION::RECEIPT", "host": [ "{{apiBaseUrl}}" ], "path": [ "records" ], "query": [ { "key": "type", "value": "TRANSACTION::RECEIPT" } ] }, "description": "Retrieve Records filtered by `type`" }, "response": [] } ], "description": "The operation type `RECEIPT` is used to certify the sale of goods or services.\n\nFor each business operation performed in the System, you must issue two sequential calls:\n\n- an `INTENTION` call at the start of the process, followed by\n \n- a `TRANSACTION` call containing the details of the operation." }, { "name": "records (CANCELLATION)", "item": [ { "name": "Create a Record::INTENTION (for original receipt)", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", " var data = pm.response.json();", " pm.environment.set(\"cancelIntentionId\", data.content.id);", "});" ], "type": "text/javascript", "packages": {}, "requests": {} } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{subjectBearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Api-Version", "value": "{{apiVersion}}", "description": "API version" }, { "key": "X-Idempotency-Key", "value": "{{$guid}}", "description": "(Required) Idempotency key" } ], "body": { "mode": "raw", "raw": "{\n \"content\": {\n \"type\": \"INTENTION\",\n \"operation\": {\n \"type\": \"TRANSACTION\"\n },\n \"system\": {\n \"id\": \"{{fiscalDeviceId}}\"\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{apiBaseUrl}}/records", "host": [ "{{apiBaseUrl}}" ], "path": [ "records" ] }, "description": "Create `INTENTION` for original receipt to be cancelled" }, "response": [] }, { "name": "Retrieve a Record::INTENTION", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});" ], "type": "text/javascript", "packages": {} } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{subjectBearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Api-Version", "value": "{{apiVersion}}", "description": "API version" } ], "url": { "raw": "{{apiBaseUrl}}/records/{{cancelIntentionId}}", "host": [ "{{apiBaseUrl}}" ], "path": [ "records", "{{cancelIntentionId}}" ] }, "description": "Retrieve the `INTENTION`" }, "response": [] }, { "name": "Create a Record::TRANSACTION::RECEIPT (to be cancelled)", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", " var data = pm.response.json();", " pm.environment.set(\"cancelReceiptId\", data.content.id);", "});" ], "type": "text/javascript", "packages": {}, "requests": {} } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{subjectBearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Api-Version", "value": "{{apiVersion}}", "description": "API version" }, { "key": "X-Idempotency-Key", "value": "{{$guid}}", "description": "(Required) Idempotency key" } ], "body": { "mode": "raw", "raw": "{\n \"content\": {\n \"type\": \"TRANSACTION\",\n \"record\": {\n \"id\": \"{{cancelIntentionId}}\"\n },\n \"operation\": {\n \"type\": \"RECEIPT\",\n \"document\": {\n \"number\": \"0003\"\n },\n \"entries\": [\n {\n \"type\": \"SALE\",\n \"details\": {\n \"concept\": \"GOOD\"\n },\n \"data\": {\n \"type\": \"ITEM\",\n \"text\": \"Product A\",\n \"unit\": {\n \"quantity\": \"1.00\",\n \"price\": {\n \"inclusive\": \"20.00\",\n \"exclusive\": \"16.39344262\"\n }\n },\n \"value\": {\n \"base\": \"16.39344262\",\n \"discount\": \"0.00\"\n },\n \"vat\": {\n \"type\": \"VAT_RATE\",\n \"code\": \"STANDARD\",\n \"percentage\": \"22.00\",\n \"exclusive\": \"16.39344262\",\n \"inclusive\": \"20.00\",\n \"amount\": \"3.60655738\"\n }\n }\n }\n ],\n \"breakdown\": [\n {\n \"type\": \"VAT_RATE\",\n \"code\": \"STANDARD\",\n \"percentage\": \"22.00\",\n \"exclusive\": \"16.39344262\",\n \"inclusive\": \"20.00\",\n \"amount\": \"3.60655738\"\n }\n ],\n \"totals\": {\n \"vat\": {\n \"amount\": \"3.60655738\",\n \"exclusive\": \"16.39344262\",\n \"inclusive\": \"20.00\"\n }\n },\n \"payments\": [\n {\n \"type\": \"CASH\",\n \"details\": {\n \"amount\": \"20.00\"\n }\n }\n ]\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{apiBaseUrl}}/records", "host": [ "{{apiBaseUrl}}" ], "path": [ "records" ] }, "description": "Create original `RECEIPT` to be cancelled" }, "response": [] }, { "name": "Retrieve a Record::TRANSACTION::RECEIPT", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});" ], "type": "text/javascript", "packages": {} } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{subjectBearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Api-Version", "value": "{{apiVersion}}", "description": "API version" } ], "url": { "raw": "{{apiBaseUrl}}/records/{{cancelReceiptId}}", "host": [ "{{apiBaseUrl}}" ], "path": [ "records", "{{cancelReceiptId}}" ] }, "description": "Retrieve the `RECEIPT` to be cancelled" }, "response": [] }, { "name": "Create a Record::INTENTION (for cancellation)", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", " var data = pm.response.json();", " pm.environment.set(\"cancellationIntentionId\", data.content.id);", "});" ], "type": "text/javascript", "packages": {}, "requests": {} } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{subjectBearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Api-Version", "value": "{{apiVersion}}", "description": "API version" }, { "key": "X-Idempotency-Key", "value": "{{$guid}}", "description": "(Required) Idempotency key" } ], "body": { "mode": "raw", "raw": "{\n \"content\": {\n \"type\": \"INTENTION\",\n \"operation\": {\n \"type\": \"TRANSACTION\"\n },\n \"system\": {\n \"id\": \"{{fiscalDeviceId}}\"\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{apiBaseUrl}}/records", "host": [ "{{apiBaseUrl}}" ], "path": [ "records" ] }, "description": "Create `INTENTION` for `CANCELLATION` transaction" }, "response": [] }, { "name": "Retrieve a Record::INTENTION", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});" ], "type": "text/javascript", "packages": {} } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{subjectBearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Api-Version", "value": "{{apiVersion}}", "description": "API version" } ], "url": { "raw": "{{apiBaseUrl}}/records/{{cancellationIntentionId}}", "host": [ "{{apiBaseUrl}}" ], "path": [ "records", "{{cancellationIntentionId}}" ] }, "description": "Retrieve the cancellation `INTENTION`" }, "response": [] }, { "name": "Create a Record::TRANSACTION::CANCELLATION", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", " var data = pm.response.json();", " pm.environment.set(\"cancellationId\", data.content.id);", "});" ], "type": "text/javascript", "packages": {}, "requests": {} } }, { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript", "packages": {}, "requests": {} } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{subjectBearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Api-Version", "value": "{{apiVersion}}", "description": "API version" }, { "key": "X-Idempotency-Key", "value": "{{$guid}}", "description": "(Required) Idempotency key" } ], "body": { "mode": "raw", "raw": "{\n \"content\": {\n \"type\": \"TRANSACTION\",\n \"record\": {\n \"id\": \"{{cancellationIntentionId}}\"\n },\n \"operation\": {\n \"type\": \"CANCELLATION\",\n \"record\": {\n \"id\": \"{{cancelReceiptId}}\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{apiBaseUrl}}/records", "host": [ "{{apiBaseUrl}}" ], "path": [ "records" ] }, "description": "Create a `CANCELLATION` transaction referencing the original `RECEIPT`" }, "response": [] }, { "name": "Retrieve a Record::TRANSACTION::CANCELLATION", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});" ], "type": "text/javascript", "packages": {} } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{subjectBearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Api-Version", "value": "{{apiVersion}}", "description": "API version" } ], "url": { "raw": "{{apiBaseUrl}}/records/{{cancellationId}}", "host": [ "{{apiBaseUrl}}" ], "path": [ "records", "{{cancellationId}}" ] }, "description": "Retrieve the `CANCELLATION` record" }, "response": [] } ], "description": "The operation type `CANCELLATION` is used to invalidate an existing `RECEIPT`.\n\nFor each business operation performed in the System, you must issue two sequential calls:\n\n- an `INTENTION` call at the start of the process, followed by\n \n- a `TRANSACTION` call containing the details of the operation.\n \n\nThis folder contains examples covering the creation of a `RECEIPT` and its subsequent `CANCELLATION`." }, { "name": "records (CORRECTION)", "item": [ { "name": "Create a Record::INTENTION (for original receipt)", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", " var data = pm.response.json();", " pm.environment.set(\"correctIntentionId\", data.content.id);", "});" ], "type": "text/javascript", "packages": {}, "requests": {} } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{subjectBearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Api-Version", "value": "{{apiVersion}}", "description": "API version" }, { "key": "X-Idempotency-Key", "value": "{{$guid}}", "description": "(Required) Idempotency key" } ], "body": { "mode": "raw", "raw": "{\n \"content\": {\n \"type\": \"INTENTION\",\n \"operation\": {\n \"type\": \"TRANSACTION\"\n },\n \"system\": {\n \"id\": \"{{fiscalDeviceId}}\"\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{apiBaseUrl}}/records", "host": [ "{{apiBaseUrl}}" ], "path": [ "records" ] }, "description": "Create `INTENTION` for original `RECEIPT` to be corrected" }, "response": [] }, { "name": "Retrieve a Record::INTENTION", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});" ], "type": "text/javascript", "packages": {} } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{subjectBearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Api-Version", "value": "{{apiVersion}}", "description": "API version" } ], "url": { "raw": "{{apiBaseUrl}}/records/{{correctIntentionId}}", "host": [ "{{apiBaseUrl}}" ], "path": [ "records", "{{correctIntentionId}}" ] }, "description": "Retrieve the `INTENTION`" }, "response": [] }, { "name": "Create a Record::TRANSACTION::RECEIPT (to be corrected)", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", " var data = pm.response.json();", " pm.environment.set(\"correctReceiptId\", data.content.id);", "});" ], "type": "text/javascript", "packages": {}, "requests": {} } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{subjectBearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Api-Version", "value": "{{apiVersion}}", "description": "API version" }, { "key": "X-Idempotency-Key", "value": "{{$guid}}", "description": "(Required) Idempotency key" } ], "body": { "mode": "raw", "raw": "{\n \"content\": {\n \"type\": \"TRANSACTION\",\n \"record\": {\n \"id\": \"{{correctIntentionId}}\"\n },\n \"operation\": {\n \"type\": \"RECEIPT\",\n \"document\": {\n \"number\": \"0004\"\n },\n \"entries\": [\n {\n \"type\": \"SALE\",\n \"details\": {\n \"concept\": \"GOOD\"\n },\n \"data\": {\n \"type\": \"ITEM\",\n \"text\": \"Product A\",\n \"unit\": {\n \"quantity\": \"3.00\",\n \"price\": {\n \"inclusive\": \"10.00\",\n \"exclusive\": \"8.19672131\"\n }\n },\n \"value\": {\n \"base\": \"24.59016393\",\n \"discount\": \"0.00\"\n },\n \"vat\": {\n \"type\": \"VAT_RATE\",\n \"code\": \"STANDARD\",\n \"percentage\": \"22.00\",\n \"exclusive\": \"24.59016393\",\n \"inclusive\": \"30.00\",\n \"amount\": \"5.40983607\"\n }\n }\n }\n ],\n \"breakdown\": [\n {\n \"type\": \"VAT_RATE\",\n \"code\": \"STANDARD\",\n \"percentage\": \"22.00\",\n \"amount\": \"5.40983607\",\n \"exclusive\": \"24.59016393\",\n \"inclusive\": \"30.00\"\n }\n ],\n \"totals\": {\n \"vat\": {\n \"amount\": \"5.40983607\",\n \"exclusive\": \"24.59016393\",\n \"inclusive\": \"30.00\"\n }\n },\n \"payments\": [\n {\n \"type\": \"CASH\",\n \"details\": {\n \"amount\": \"30.00\"\n }\n }\n ]\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{apiBaseUrl}}/records", "host": [ "{{apiBaseUrl}}" ], "path": [ "records" ] }, "description": "Create original `RECEIPT` to be corrected" }, "response": [] }, { "name": "Retrieve a Record::TRANSACTION::RECEIPT", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});" ], "type": "text/javascript", "packages": {} } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{subjectBearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Api-Version", "value": "{{apiVersion}}", "description": "API version" } ], "url": { "raw": "{{apiBaseUrl}}/records/{{correctReceiptId}}", "host": [ "{{apiBaseUrl}}" ], "path": [ "records", "{{correctReceiptId}}" ] }, "description": "Retrieve the `RECEIPT` to be corrected" }, "response": [] }, { "name": "Create a Record::INTENTION (for correction)", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", " var data = pm.response.json();", " pm.environment.set(\"correctionIntentionId\", data.content.id);", "});" ], "type": "text/javascript", "packages": {}, "requests": {} } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{subjectBearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Api-Version", "value": "{{apiVersion}}", "description": "API version" }, { "key": "X-Idempotency-Key", "value": "{{$guid}}", "description": "(Required) Idempotency key" } ], "body": { "mode": "raw", "raw": "{\n \"content\": {\n \"type\": \"INTENTION\",\n \"operation\": {\n \"type\": \"TRANSACTION\"\n },\n \"system\": {\n \"id\": \"{{fiscalDeviceId}}\"\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{apiBaseUrl}}/records", "host": [ "{{apiBaseUrl}}" ], "path": [ "records" ] }, "description": "Create `INTENTION` for `CORRECTION` transaction" }, "response": [] }, { "name": "Retrieve a Record::INTENTION", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});" ], "type": "text/javascript", "packages": {} } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{subjectBearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Api-Version", "value": "{{apiVersion}}", "description": "API version" } ], "url": { "raw": "{{apiBaseUrl}}/records/{{correctionIntentionId}}", "host": [ "{{apiBaseUrl}}" ], "path": [ "records", "{{correctionIntentionId}}" ] }, "description": "Retrieve the correction `INTENTION`" }, "response": [] }, { "name": "Create a Record::TRANSACTION::CORRECTION", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", " var data = pm.response.json();", " pm.environment.set(\"correctionId\", data.content.id);", "});" ], "type": "text/javascript", "packages": {}, "requests": {} } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{subjectBearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Api-Version", "value": "{{apiVersion}}", "description": "API version" }, { "key": "X-Idempotency-Key", "value": "{{$guid}}", "description": "(Required) Idempotency key" } ], "body": { "mode": "raw", "raw": "{\n \"content\": {\n \"type\": \"TRANSACTION\",\n \"record\": {\n \"id\": \"{{correctionIntentionId}}\"\n },\n \"operation\": {\n \"type\": \"CORRECTION\",\n \"record\": {\n \"id\": \"{{correctReceiptId}}\"\n },\n \"data\": {\n \"type\": \"RECEIPT\",\n \"document\": {\n \"number\": \"0005\"\n },\n \"entries\": [\n {\n \"type\": \"RETURN\",\n \"details\": {\n \"concept\": \"GOOD\",\n \"number\": \"1\"\n },\n \"data\": {\n \"type\": \"ITEM\",\n \"text\": \"Product A\",\n \"unit\": {\n \"quantity\": \"1.00\",\n \"price\": {\n \"inclusive\": \"10.00\",\n \"exclusive\": \"8.19672131\"\n }\n },\n \"value\": {\n \"base\": \"8.19672131\",\n \"discount\": \"0.00\"\n },\n \"vat\": {\n \"type\": \"VAT_RATE\",\n \"code\": \"STANDARD\",\n \"percentage\": \"22.00\",\n \"exclusive\": \"8.19672131\",\n \"inclusive\": \"10.00\",\n \"amount\": \"1.80327869\"\n }\n }\n }\n ],\n \"breakdown\": [\n {\n \"type\": \"VAT_RATE\",\n \"code\": \"STANDARD\",\n \"percentage\": \"22.00\",\n \"amount\": \"1.80327869\",\n \"exclusive\": \"8.19672131\",\n \"inclusive\": \"10.00\"\n }\n ],\n \"totals\": {\n \"vat\": {\n \"amount\": \"1.80327869\",\n \"exclusive\": \"8.19672131\",\n \"inclusive\": \"10.00\"\n }\n },\n \"payments\": [\n {\n \"type\": \"CASH\",\n \"details\": {\n \"amount\": \"10.00\"\n }\n }\n ]\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{apiBaseUrl}}/records", "host": [ "{{apiBaseUrl}}" ], "path": [ "records" ] }, "description": "Create a `CORRECTION` transaction" }, "response": [] }, { "name": "Retrieve a Record::TRANSACTION::CORRECTION", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});" ], "type": "text/javascript", "packages": {} } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{subjectBearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Api-Version", "value": "{{apiVersion}}", "description": "API version" } ], "url": { "raw": "{{apiBaseUrl}}/records/{{correctionId}}", "host": [ "{{apiBaseUrl}}" ], "path": [ "records", "{{correctionId}}" ] }, "description": "Retrieve the `CORRECTION` record" }, "response": [] } ], "description": "The operation type `CORRECTION` is used to represent a return process.\n\nFor each business operation performed in the System, you must issue two sequential calls:\n\n- an `INTENTION` call at the start of the process, followed by\n \n- a `TRANSACTION` call containing the details of the operation.\n \n\nThis folder contains examples covering the creation of a `RECEIPT` and its subsequent `CORRECTION`." }, { "name": "records (Get record PDF)", "item": [ { "name": "Create a Record::INTENTION", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", " var data = pm.response.json();", " pm.environment.set(\"pdfIntentionId\", data.content.id);", "});" ], "type": "text/javascript", "packages": {}, "requests": {} } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{subjectBearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Api-Version", "value": "{{apiVersion}}", "description": "API version" }, { "key": "X-Idempotency-Key", "value": "{{$guid}}", "description": "(Required) Idempotency key" } ], "body": { "mode": "raw", "raw": "{\n \"content\": {\n \"type\": \"INTENTION\",\n \"operation\": {\n \"type\": \"TRANSACTION\"\n },\n \"system\": {\n \"id\": \"{{fiscalDeviceId}}\"\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{apiBaseUrl}}/records", "host": [ "{{apiBaseUrl}}" ], "path": [ "records" ] }, "description": "Create a `Record::INTENTION` for PDF generation workflow" }, "response": [] }, { "name": "Create a Record::TRANSACTION::RECEIPT", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", " var data = pm.response.json();", " pm.environment.set(\"pdfReceiptId\", data.content.id);", "});" ], "type": "text/javascript", "packages": {}, "requests": {} } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{subjectBearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Api-Version", "value": "{{apiVersion}}", "description": "API version" }, { "key": "X-Idempotency-Key", "value": "{{$guid}}", "description": "(Required) Idempotency key" } ], "body": { "mode": "raw", "raw": "{\n \"content\": {\n \"type\": \"TRANSACTION\",\n \"record\": {\n \"id\": \"{{pdfIntentionId}}\"\n },\n \"operation\": {\n \"type\": \"RECEIPT\",\n \"document\": {\n \"number\": \"0002\"\n },\n \"entries\": [\n {\n \"type\": \"SALE\",\n \"details\": {\n \"concept\": \"GOOD\"\n },\n \"data\": {\n \"type\": \"ITEM\",\n \"text\": \"PDF Test Product\",\n \"unit\": {\n \"quantity\": \"1.00\",\n \"price\": {\n \"inclusive\": \"15.00\",\n \"exclusive\": \"12.29508197\"\n }\n },\n \"value\": {\n \"base\": \"12.29508197\",\n \"discount\": \"0.00\"\n },\n \"vat\": {\n \"type\": \"VAT_RATE\",\n \"code\": \"STANDARD\",\n \"percentage\": \"22.00\",\n \"exclusive\": \"12.29508197\",\n \"inclusive\": \"15.00\",\n \"amount\": \"2.70491803\"\n }\n }\n }\n ],\n \"breakdown\": [\n {\n \"type\": \"VAT_RATE\",\n \"code\": \"STANDARD\",\n \"percentage\": \"22.00\",\n \"amount\": \"2.70491803\",\n \"exclusive\": \"12.29508197\",\n \"inclusive\": \"15.00\"\n }\n ],\n \"totals\": {\n \"vat\": {\n \"amount\": \"2.70491803\",\n \"exclusive\": \"12.29508197\",\n \"inclusive\": \"15.00\"\n }\n },\n \"payments\": [\n {\n \"type\": \"CARD\",\n \"number\": \"123456789\",\n \"kind\": \"DEBIT\",\n \"details\": {\n \"amount\": \"15.00\"\n }\n }\n ]\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{apiBaseUrl}}/records", "host": [ "{{apiBaseUrl}}" ], "path": [ "records" ] }, "description": "Create a `RECEIPT` for PDF generation" }, "response": [] }, { "name": "Retrieve a Record::TRANSACTION::RECEIPT", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});" ], "type": "text/javascript", "packages": {} } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{subjectBearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/pdf" }, { "key": "X-Api-Version", "value": "{{apiVersion}}", "description": "API version" } ], "url": { "raw": "{{apiBaseUrl}}/records/{{pdfReceiptId}}", "host": [ "{{apiBaseUrl}}" ], "path": [ "records", "{{pdfReceiptId}}" ] }, "description": "Retrieve the `RECEIPT` record" }, "response": [] }, { "name": "Retrieve a PDF", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});", "", "const base64 = pm.response.json()?.content?.compliance?.artifact?.data;", "", "if (base64) {", " const link = `data:application/pdf;base64,${base64}`;", " pm.visualizer.set(`", " ", " ", "

ð PDF Base64 Link

", "

Open that link in your browser:

", " ", " ", " ", " `);", "} else {", " pm.visualizer.set(`

â ï¸ No PDF Base64 data found.

`);", "}", "" ], "type": "text/javascript", "packages": {}, "requests": {} } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{subjectBearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/pdf" }, { "key": "X-Api-Version", "value": "{{apiVersion}}", "description": "API version" } ], "url": { "raw": "{{apiBaseUrl}}/records/{{pdfReceiptId}}?compliance-artifact", "host": [ "{{apiBaseUrl}}" ], "path": [ "records", "{{pdfReceiptId}}" ], "query": [ { "key": "compliance-artifact", "value": null } ] }, "description": "Retrieve a `RECEIPT` as PDF by setting `Accept` header to `application/pdf`" }, "response": [] } ], "description": "This folder walks through creating a `RECEIPT` and then retrieving the official AdE record PDF (base64-encoded) for it." }, { "name": "systems (Pagination)", "item": [ { "name": "Create system Connected to Taxpayer", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", " var data = pm.response.json();", " pm.environment.set(\"paginationSystemIdListTest\", data.content.id);", "});" ], "type": "text/javascript", "packages": {}, "requests": {} } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{subjectBearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Api-Version", "value": "{{apiVersion}}", "description": "API version" }, { "key": "X-Idempotency-Key", "value": "{{$guid}}", "description": "(Required) Idempotency key" } ], "body": { "mode": "raw", "raw": "{\n \"content\": {\n \"type\": \"FISCAL_DEVICE\",\n \"kind\": \"INTERNAL\",\n \"location\": {\n \"id\": \"{{locationId}}\"\n },\n \"producer\": {\n \"type\": \"MPN\",\n \"number\": \"PAG-001\",\n \"details\": {\n \"name\": \"Pagination Test Device\",\n \"model\": \"PAG-Model\",\n \"serial\": \"PAG-SERIAL-001\"\n }\n },\n \"software\": {\n \"name\": \"OPERA lite\",\n \"version\": \"v1.0.0\"\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{apiBaseUrl}}/systems", "host": [ "{{apiBaseUrl}}" ], "path": [ "systems" ] }, "description": "Create a `System::FISCAL_DEVICE` for pagination testing" }, "response": [] }, { "name": "List Systems With Limit", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", " var data = pm.response.json();", " if (data.pagination && data.pagination.token) {", " pm.environment.set(\"systemPaginationToken\", data.pagination.token);", " }", "});" ], "type": "text/javascript", "packages": {}, "requests": {} } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{subjectBearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Api-Version", "value": "{{apiVersion}}", "description": "API version" } ], "url": { "raw": "{{apiBaseUrl}}/systems?limit=1", "host": [ "{{apiBaseUrl}}" ], "path": [ "systems" ], "query": [ { "key": "limit", "value": "1" } ] }, "description": "List systems with `limit` query parameter" }, "response": [] }, { "name": "List Systems With Taxpayer Filter", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});" ], "type": "text/javascript", "packages": {} } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{subjectBearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Api-Version", "value": "{{apiVersion}}", "description": "API version" } ], "url": { "raw": "{{apiBaseUrl}}/systems?taxpayer_id={{taxpayerId}}", "host": [ "{{apiBaseUrl}}" ], "path": [ "systems" ], "query": [ { "key": "taxpayer_id", "value": "{{taxpayerId}}" } ] }, "description": "List systems with `taxpayer_id` query parameter" }, "response": [] }, { "name": "List Systems With Location Filter", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});" ], "type": "text/javascript", "packages": {} } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{subjectBearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Api-Version", "value": "{{apiVersion}}", "description": "API version" } ], "url": { "raw": "{{apiBaseUrl}}/systems?location_id={{locationId}}", "host": [ "{{apiBaseUrl}}" ], "path": [ "systems" ], "query": [ { "key": "location_id", "value": "{{locationId}}" } ] }, "description": "List systems with `location_id` query parameter" }, "response": [] } ], "description": "This folder walks through creating a `System::FISCAL_DEVICE` to test pagination limits and other filters when listing systems." } ] }